Skip to content

Commit 42c50cb

Browse files
committed
docs: describe the code-signing environment and tag rules in RELEASING.md
1 parent 98a854e commit 42c50cb

1 file changed

Lines changed: 13 additions & 6 deletions

File tree

‎RELEASING.md‎

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,9 @@ Desktop. All of them are produced by the
1212

1313
1. Bump the version in `pkg/mutagen/version.go` and merge that change.
1414
2. Tag the merged commit and push the tag. The tag must match the version
15-
(`v` prefix plus `mutagen version` output):
15+
(`v` prefix plus `mutagen version` output). Only repository admins,
16+
maintainers and the `release-managers` team may push `v*` tags (the
17+
`Release tags` ruleset in coder/github-org-terraform):
1618

1719
```bash
1820
git tag -a v0.18.4 -m v0.18.4
@@ -21,10 +23,12 @@ Desktop. All of them are produced by the
2123

2224
The release workflow builds and signs the artifacts and creates a GitHub
2325
release with them attached. Running the workflow manually from the Actions
24-
tab builds the same artifacts from any ref and attaches them to the workflow
25-
run instead, which is useful for a dry run.
26+
tab on `main` builds the same artifacts and attaches them to the workflow
27+
run instead, which is useful for a dry run. Signing jobs run in the
28+
`code-signing` environment, which only `main` and `v*` tags may use, so a
29+
manual run from any other branch fails.
2630
3. Run the [Upload release workflow](.github/workflows/upload-release.yml)
27-
manually from the Actions tab, with the existing release tag (for example,
31+
manually from the Actions tab on `main`, with the existing release tag (for example,
2832
`v0.18.4`) as the `tag` input. It downloads the five release payloads and
2933
`SHA256SUMS`, verifies the complete checksum manifest, and uploads the files
3034
to `gs://coder-desktop/mutagen/<tag>/` without rebuilding or re-signing them.
@@ -63,8 +67,11 @@ Federation. It needs the following repository configuration:
6367
as coder/coder
6468

6569
The service account, its Cloud KMS roles, and its workload identity binding
66-
for this repository are managed in coder/gcp under
67-
`projects/production/coder-ci`.
70+
are managed in coder/gcp under `projects/production/coder-ci`. The binding
71+
only trusts jobs in this repository's `code-signing` environment
72+
(`repo:coder/mutagen:environment:code-signing`), which is managed in
73+
coder/github-org-terraform. Every job that authenticates as the service
74+
account, including the upload workflow, must run in that environment.
6875

6976
## Upload setup
7077

0 commit comments

Comments
 (0)