Skip to content

Commit ca2f3ff

Browse files
committed
docs(release): update release process to reflect workflow_dispatch deploy trigger
- Replace outdated 'release: published' trigger description with the actual mechanism (release.yml calls gh workflow run after creating the GitHub Release) - Add explanation of why workflow_dispatch is used instead of release: published (GITHUB_TOKEN cascade limitation) - Note that deploy workflows can be triggered manually from the Actions tab for hotfix deployments https://claude.ai/code/session_01JDVdCKNUcJfnKCaZZipMWW
1 parent c2e4803 commit ca2f3ff

1 file changed

Lines changed: 6 additions & 3 deletions

File tree

docs/processes/release.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -41,9 +41,8 @@ Merging the release PR triggers `release.yml`, which:
4141

4242
1. Reads the version from `pubspec.yaml` (source of truth)
4343
2. Creates and pushes the git tag (e.g. `v2026.5.5`)
44-
3. Creates a GitHub Release from that tag with the `CHANGELOG.md` body
45-
46-
Creating the GitHub Release triggers the deployment workflows (via `on: release: published`):
44+
3. Creates a GitHub Release with the changelog for that version
45+
4. Explicitly triggers the deployment workflows via `workflow_dispatch`
4746

4847
| Workflow | Action |
4948
|----------|--------|
@@ -52,6 +51,8 @@ Creating the GitHub Release triggers the deployment workflows (via `on: release:
5251

5352
Monitor progress in the [Actions tab](https://github.com/richardthe3rd/cambridge-beer-festival-app/actions).
5453

54+
> **Why `workflow_dispatch` and not `release: published`?** GitHub does not fire workflow triggers in response to events created by `GITHUB_TOKEN`. Using `gh workflow run` sidesteps this limitation without requiring a PAT.
55+
5556
## What goes into a release
5657

5758
git-cliff reads conventional commit messages since the last tag. The following types are included:
@@ -80,6 +81,8 @@ git push origin hotfix/fix-description
8081

8182
After merging to `main`, the release PR will pick up the fix in the next run and compute the next patch version automatically.
8283

84+
To deploy a hotfix without waiting for the release PR flow, you can trigger the deployment workflows manually from the [Actions tab](https://github.com/richardthe3rd/cambridge-beer-festival-app/actions) — select `Release Web to Cloudflare Pages` or `Release Android` and provide the version tag.
85+
8386
## Promote Android release (manual)
8487

8588
Once the Internal track build is available:

0 commit comments

Comments
 (0)