mirror of
https://github.com/coder/coder.git
synced 2026-09-23 22:20:22 +08:00
Garrett Delfosse
bfbacd64f4
## 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.
97 lines
2.1 KiB
Go
97 lines
2.1 KiB
Go
package v2 //nolint:testpackage // Tests unexported release helpers.
|
|
|
|
import (
|
|
"testing"
|
|
|
|
"github.com/stretchr/testify/require"
|
|
)
|
|
|
|
func Test_parseVersion(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
tests := []struct {
|
|
input string
|
|
wantErr bool
|
|
want version
|
|
}{
|
|
{
|
|
input: "v2.21.0",
|
|
want: version{major: 2, minor: 21, patch: 0, rc: -1, original: "v2.21.0"},
|
|
},
|
|
{
|
|
input: "v2.21.0-rc.3",
|
|
want: version{major: 2, minor: 21, patch: 0, rc: 3, original: "v2.21.0-rc.3"},
|
|
},
|
|
{
|
|
input: "2.21.0",
|
|
want: version{major: 2, minor: 21, patch: 0, rc: -1, original: "v2.21.0"},
|
|
},
|
|
{
|
|
input: "v0.0.0",
|
|
want: version{major: 0, minor: 0, patch: 0, rc: -1, original: "v0.0.0"},
|
|
},
|
|
{
|
|
input: "v1.2.3-rc.0",
|
|
want: version{major: 1, minor: 2, patch: 3, rc: 0, original: "v1.2.3-rc.0"},
|
|
},
|
|
{
|
|
input: "not-a-version",
|
|
wantErr: true,
|
|
},
|
|
{
|
|
input: "",
|
|
wantErr: true,
|
|
},
|
|
{
|
|
input: "v1.2",
|
|
wantErr: true,
|
|
},
|
|
}
|
|
|
|
for _, tt := range tests {
|
|
t.Run(tt.input, func(t *testing.T) {
|
|
t.Parallel()
|
|
got, err := parseVersion(tt.input)
|
|
if tt.wantErr {
|
|
require.Error(t, err)
|
|
return
|
|
}
|
|
require.NoError(t, err)
|
|
require.Equal(t, tt.want.major, got.major, "major")
|
|
require.Equal(t, tt.want.minor, got.minor, "minor")
|
|
require.Equal(t, tt.want.patch, got.patch, "patch")
|
|
require.Equal(t, tt.want.rc, got.rc, "rc")
|
|
require.Equal(t, tt.want.original, got.original, "original")
|
|
})
|
|
}
|
|
}
|
|
|
|
func Test_versionString(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
tests := []struct {
|
|
v version
|
|
want string
|
|
}{
|
|
{version{major: 2, minor: 21, patch: 0, rc: -1}, "v2.21.0"},
|
|
{version{major: 2, minor: 21, patch: 0, rc: 3}, "v2.21.0-rc.3"},
|
|
{version{major: 1, minor: 0, patch: 5, rc: -1}, "v1.0.5"},
|
|
{version{major: 1, minor: 0, patch: 0, rc: 0}, "v1.0.0-rc.0"},
|
|
}
|
|
|
|
for _, tt := range tests {
|
|
t.Run(tt.want, func(t *testing.T) {
|
|
t.Parallel()
|
|
require.Equal(t, tt.want, tt.v.String())
|
|
})
|
|
}
|
|
}
|
|
|
|
func Test_versionIsRC(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
require.True(t, version{rc: 0}.IsRC())
|
|
require.True(t, version{rc: 3}.IsRC())
|
|
require.False(t, version{rc: -1}.IsRC())
|
|
}
|