Merge remote-tracking branch 'origin/main' into cargo-generate

TheBevyFlock · Jul 18, 2024 · c2138a1 · c2138a1
2 parents 9d2676b + c9b81b0
commit c2138a1
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 3 deletions.
diff --git a/docs/workflow-itch-release.png b/docs/workflow-itch-release.png
diff --git a/docs/workflows.md b/docs/workflows.md
@@ -42,7 +42,11 @@ Enter a version number in the format `v1.2.3`, then hit the green `Run workflow`
 
 ### Set up variables
 
-Open [`.github/workflows/release.yaml`](../.github/workflows/release.yaml) and navigate to this section:
+[`.github/workflows/release.yaml`](../.github/workflows/release.yaml) contains a list of environment variables that are set automatically by `cargo generate`.
+Otherwise, you will have to fill them in manually and push a commit.
+
+<details>
+<summary>Environment variables section of the release workflow</summary>
 
 ```yaml
 env:
@@ -64,7 +68,9 @@ env:
   USE_GIT_LFS: false
 ```
 
-Update the values for your project and push a commit.
+</details>
+
+In any case, make note of the value used for `ITCH_TARGET`, as you will need it later.
 
 ### Set up permissions
 
@@ -78,7 +84,15 @@ Set `Workflow permissions` to `Read and write permissions`, then hit `Save`:
 
 ### Set up itch.io upload
 
-Create your itch.io page with `Kind of project = HTML`, and double-check that the [`ITCH_TARGET` variable](#set-up-variables) you've set up earlier matches your itch.io page.
+#### Create page
+
+Create your itch.io page with the same name as is used in the `ITCH_TARGET` variable in [release.yaml](../.github/workflows/release.yaml).
+By default, this is the same as the project name.
+Also set `Kind of project` to `HTML`.
+
+On your project page, you'll see a warning saying "There was a problem loading your project: No file provided to embed". This is because we haven't uploaded a release yet. Don't worry about it, we will fix that in a moment.
+
+#### Add butler credentials
 
 In your GitHub repository, navigate to `Settings > Secrets and variables > Actions`:
 
@@ -88,3 +102,10 @@ Hit `New repository secret` and enter the following, then hit `Add secret`:
 
 - **Name:** `BUTLER_CREDENTIALS`
 - **Secret:** Your [itch.io API key](https://itch.io/user/settings/api-keys) (create a new one if necessary)
+
+#### Select the web build
+
+[Run your workflow](#cd-releasing) once. When it's done, go back to itch.io and edit your project.
+Scroll to `Uploads`, where you should now see a bunch of files. Find the one tagged `web` and tick the box that says "This file will be played in the browser". You only have to do this once on your first release.
+
+![A screenshot showing a web build selected in the itch.io uploads](workflow-itch-release.png)