Files
coder/scripts/releaser/executor.go
T
Kyle CarberryandClaude Opus 5.5 12766eca93 ci: create release tags and branches with the release App after approval (#32212)
## Summary

**Unblocks releases after the `coder/coder` lockdown.** Only the
`coder-release-publisher` App can now create tags and release branches
(rulesets "Release tags (App only)" and "Release branch creation",
managed in `coder/github-org-terraform`). Its key is only available in
environments that need a **second release manager's approval**
(`release-managers`, no self-review, no admin bypass). People can't push
release tags anymore, so the tag is now created **inside the approved
release run**.

### Releasing (`./scripts/release.sh` works as before, minus one step)

1. Run `./scripts/release.sh` on `release/X.Y` (or `main` for an RC), as
today. It still picks the version, checks open PRs and breaking changes,
and writes the release notes.
2. Instead of creating and pushing the tag, it checks the commit is
already on `origin/<branch>` and dispatches `release.yaml` **on the
branch** with `version`, `commit`, `release_channel` and
`release_notes`.
3. The releaser prints the run's URL. GitHub also notifies the
`release-managers` reviewers. **Another release manager approves** the
run's `release` environment (Review deployments).
4. The approved job creates the annotated tag `version` at `commit` with
the App, then builds, signs and publishes that commit as before.

`release.yaml` can also be run by hand from the Actions UI with the same
inputs.

### `release.yaml`

- New `version` and `commit` inputs (required unless `dry_run`).
- The `release` job checks out `commit`. Before anything else, it:
  - refuses a malformed version;
- refuses a version that doesn't match the branch (`release/X.Y`, or
`main`/`release/X.Y` for `-rc.N`);
  - refuses a commit that isn't already on the dispatched branch;
  - refuses an existing tag that points elsewhere;
- otherwise creates the annotated tag with the App. A re-run reuses a
tag already at that commit.

  `version.sh` and the rest of the job are unchanged.
- **Homebrew and the `coder/packages` dispatch use the new
`coder-package-publisher` App** (`release-publish` environment) instead
of `CDRCI_GITHUB_TOKEN`. The dispatch moves to its own
`publish-packages` job in `release-publish`, where that key lives; it's
approved together with Homebrew and winget. Winget still uses the
`cdrci` machine user, since an App can't open PRs on
`microsoft/winget-pkgs`.
- Every App token is scoped to one repository and the permissions it
needs (`zizmor`'s `github-app` audit: 5 high findings to 0, one of which
predates this PR).

### `create-release-branch.yaml` (new)

Dispatched on `main` with `version` (e.g. `2.40`) and `commit`. After
approval in the `release-refs` environment, it creates `release/X.Y` at
that commit, refusing one that isn't on `main` or a branch that already
exists.

### `scripts/releaser`

- `ReleaseExecutor` drops `CreateTag`/`PushTag`.
- `TriggerWorkflow` dispatches on the branch with `version` and
`commit`.
- An existing tag must already point at HEAD.
- After dispatching, it looks up the run (`gh run list`, polling
briefly) and prints its URL and the approval steps.

## Before merging

- [ ] `RELEASE_APP_ID` and `RELEASE_APP_PRIVATE_KEY` set in the
**`release-refs`** environment (currently empty), and the rotated
release App key in `release`.
- [x] `CODER_PACKAGE_PUBLISHER_APP_ID` /
`CODER_PACKAGE_PUBLISHER_APP_PRIVATE_KEY` in `release-publish`; App
installed on `homebrew-coder` and `packages`.

## After merging: backport to every branch you release from

`release.yaml` runs from the dispatched branch's own copy, and
`./scripts/release.sh` runs the branch's releaser. So **each
`release/X.Y` needs this change before it can release**. Active lines by
recent tags: `release/2.39`, `2.38`, `2.37`, `2.36`, `2.35`, `2.34`,
`2.29`.

## Relation to #31321

#31321 (`Tag release`) runs the releaser non-interactively in CI. This
PR is the smaller change that unblocks releases now. #31321 can build on
it: its tagging job would need `environment: release-refs` (where the
App key lives) plus the extra App permissions it asks for, which are a
manifest change in `coder/github-org-terraform` `apps/`.

## Testing

- `go build`, `go vet`, `go test ./scripts/releaser` pass.
- `actionlint` and `zizmor` are clean on both workflows.
- Not exercised end to end. Suggest the first use be an RC
(`v2.40.0-rc.N` from `main`), watching the tag step.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

---------

Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-15 19:54:29 -05:00

63 lines
1.9 KiB
Go

package main
import (
"context"
"encoding/json"
"fmt"
"io"
"os"
"os/exec"
"strings"
"golang.org/x/xerrors"
)
// ReleaseExecutor handles dangerous write/mutating operations
// that should be skipped in dry-run mode. Only actions that
// modify the git repo or trigger external side effects belong
// here. Safe operations (file writes, fetches, editor) are
// called directly.
type ReleaseExecutor interface {
// TriggerWorkflow dispatches the release.yaml GitHub Actions
// workflow on branch with the given inputs. The workflow creates
// the release tag at commit once its release environment is
// approved: only the release GitHub App may create tags.
TriggerWorkflow(ctx context.Context, branch, version, commit, channel, releaseNotes string) error
}
// liveExecutor performs real operations.
type liveExecutor struct{}
func (*liveExecutor) TriggerWorkflow(_ context.Context, branch, version, commit, channel, releaseNotes string) error {
payload := map[string]string{
"dry_run": "false",
"release_channel": channel,
"release_notes": releaseNotes,
"version": version,
"commit": commit,
}
payloadJSON, err := json.Marshal(payload)
if err != nil {
return xerrors.Errorf("marshaling workflow payload: %w", err)
}
cmd := exec.Command("gh", "workflow", "run", "release.yaml",
"--repo", owner+"/"+repo,
"--ref", branch,
"--json",
)
cmd.Stdin = strings.NewReader(string(payloadJSON))
cmd.Stdout = os.Stdout
cmd.Stderr = os.Stderr
return cmd.Run()
}
// dryRunExecutor prints what would happen without doing it.
type dryRunExecutor struct {
w io.Writer
}
func (e *dryRunExecutor) TriggerWorkflow(_ context.Context, branch, version, commit, channel, _ string) error {
_, _ = fmt.Fprintf(e.w, "[DRYRUN] would trigger release.yaml workflow (ref=%s, version=%s, commit=%s, channel=%s)\n", branch, version, commit, channel)
return nil
}