Files
coder/scripts/releaser/main.go
T
Garrett Delfosse bfbacd64f4 refactor: consolidate release tooling into a single releaser command (#27034)
## What

Consolidates the two separate release programs into a single command at
`scripts/releaser`:

- `scripts/releaser/v1/` — the former interactive releaser (package
`v1`).
- `scripts/releaser/v2/` — the former `scripts/release-action` CI tool
(package `v2`).
- `scripts/releaser/main.go` — new entrypoint. Runs the **v2** tooling
by
  default and the **v1** interactive wizard with `--legacy`.

## CLI shape

Three documented subcommands, each backed by v2 `prepare-release` with
the
release type baked in:

- `releaser rc` — tag a release candidate
- `releaser branch` — cut a new release branch and tag its first RC
- `releaser release` — tag a stable release or patch

The former release-action verbs (`calculate-version`, `prepare-release`,
`generate-notes`, `publish`) are retained as **hidden** top-level
commands with
identical flags and stdout, so `tag-and-release.yaml` migrates with a
path-only
change (`scripts/release-action` -> `scripts/releaser`). `--legacy` runs
the v1
wizard and is mutually exclusive with the subcommands.
`scripts/release.sh` now
launches `releaser --legacy`.

All file moves are rename-detected by git, so the per-file diff is just
the
package declaration.

## Testing

- `go build ./scripts/...`, `go vet ./scripts/releaser/...`, `go test
./scripts/releaser/...`
- `golangci-lint run ./scripts/releaser/...`, `make lint/emdash`,
`shellcheck`, `actionlint`
- Smoke: `releaser --help` shows only rc/branch/release; hidden verbs
still run;
`releaser rc --ref main --dry-run` emits the same JSON contract;
`--legacy rc`
  errors cleanly.

<details>
<summary>Implementation plan</summary>

# Plan: Consolidate release tooling into a single `scripts/releaser`
command

## Goal

Merge the two separate release programs into one binary at
`scripts/releaser`:

- `scripts/releaser/v1/` — the current interactive releaser (package
`v1`).
- `scripts/releaser/v2/` — the current CI `scripts/release-action`
(package `v2`).
- `scripts/releaser/main.go` — new entrypoint (package `main`).
  - Uses v2 by default, v1 with `--legacy`.
- Exposes 3 subcommands: `rc`, `branch` (cut release branch), `release`.

## Design decision (Option A, chosen)

The workflow needs `prepare-release`, `generate-notes`, and `publish`
invokable
separately (a build happens between prepare and publish). The latter two
are
version-driven and type-agnostic, so they do not map cleanly onto
`rc`/`branch`/`release`.

- Visible subcommands `rc`, `branch`, `release` run v2 `prepare-release`
with the
  type baked in and print the same JSON.
- Hidden verbs `calculate-version`, `prepare-release`, `generate-notes`,
  `publish` keep byte-identical flags/stdout, so the workflow change is
  path-only. Lowest risk; honors "3 subcommands" from a UX perspective.

## `--legacy` semantics

- `releaser --legacy` runs the v1 interactive wizard (preserves today's
  behavior; the wizard auto-detects RC vs release from the branch).
- `--legacy` is mutually exclusive with the subcommands (clear error if
  combined), because v1 auto-detects type and cannot cut a branch.

## Work items

1. Create `v1` and `v2` packages via `git mv`, renaming `package main`.
Move the `owner`/`repo` consts into each package. Add `v1.Run(inv,
dryRun)`
   (old wizard `main()` body) and v2 command builders (`CICommands`,
   `TypeCommand`) so internals stay unexported.
2. New `scripts/releaser/main.go`: top-level `releaser` with `--legacy`,
the 3
subcommands, and the hidden compat verbs; delegates to `v1.Run` for
legacy.
3. Update references: `tag-and-release.yaml` (3 command paths + header
comment)
   and `scripts/release.sh` (`--legacy`).
4. Verify: build, vet, test, `go run` smoke tests, fmt, lint.
5. Open a single PR from a feature branch.

## Risks / notes

- stdout contract for rc/branch/release and the hidden verbs must stay
identical
  (workflow parses stdout); logs go to stderr.
- Patch releases from pre-existing `release/X.Y` branches run those
branches'
own (old) workflow + `scripts/release-action`, so they stay
self-consistent.
New releases cut from branches containing this change get the new
workflow +
`scripts/releaser`. No forwarding stub needed since code and workflow
ship
  together.

</details>

---

This PR was created by Coder Agents on behalf of @f0ssel.
2026-07-07 11:13:50 -04:00

97 lines
2.8 KiB
Go

package main
import (
"errors"
"os"
"golang.org/x/xerrors"
"github.com/coder/coder/v2/cli/cliui"
releaserv1 "github.com/coder/coder/v2/scripts/releaser/v1"
releaserv2 "github.com/coder/coder/v2/scripts/releaser/v2"
"github.com/coder/pretty"
"github.com/coder/serpent"
)
func main() {
var (
legacy bool
dryRun bool
)
// Default (v2) subcommands. rc, branch, and release run the
// non-interactive prepare-release logic with the release type baked
// in.
children := []*serpent.Command{
releaserv2.TypeCommand("rc", "Tag a release candidate from main or a release branch.", "rc"),
releaserv2.TypeCommand("branch", "Cut a new release branch and tag its first release candidate.", "create-release-branch"),
releaserv2.TypeCommand("release", "Tag a stable release or patch from a release branch.", "release"),
}
// Hidden compatibility verbs. These preserve the exact names, flags,
// and stdout contract of the former scripts/release-action tool so
// GitHub Actions workflows migrate with a path-only change.
for _, c := range releaserv2.CICommands() {
c.Hidden = true
children = append(children, c)
}
// --legacy selects the v1 interactive wizard and cannot be combined
// with a subcommand, which v1 does not understand.
for _, c := range children {
next := c.Handler
c.Handler = func(inv *serpent.Invocation) error {
if legacy {
return xerrors.New("--legacy cannot be combined with a subcommand; run 'releaser --legacy' for the interactive tool")
}
return next(inv)
}
}
cmd := &serpent.Command{
Use: "releaser <subcommand>",
Short: "Release tooling for coder/coder.",
Long: "Tag and publish releases for coder/coder.\n\n" +
"By default releaser runs the non-interactive tooling via the rc,\n" +
"branch, and release subcommands. Pass --legacy to run the older\n" +
"interactive release wizard instead.",
Options: serpent.OptionSet{
{
Name: "legacy",
Flag: "legacy",
Description: "Run the legacy interactive release wizard.",
Value: serpent.BoolOf(&legacy),
},
{
Name: "dry-run",
Flag: "dry-run",
Description: "Print mutating commands instead of executing them (legacy wizard only).",
Value: serpent.BoolOf(&dryRun),
},
},
Children: children,
Handler: func(inv *serpent.Invocation) error {
if legacy {
return releaserv1.Run(inv, dryRun)
}
// No subcommand given and not in legacy mode: show help.
return serpent.DefaultHelpFn()(inv)
},
}
err := cmd.Invoke().WithOS().Run()
if err != nil {
if errors.Is(err, cliui.ErrCanceled) {
os.Exit(1)
}
// Unwrap serpent's "running command ..." wrapper to keep output
// clean.
var runErr *serpent.RunCommandError
if errors.As(err, &runErr) {
err = runErr.Err
}
pretty.Fprintf(os.Stderr, cliui.DefaultStyles.Error, "Error: %s\n", err)
os.Exit(1)
}
}