Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 17 additions & 3 deletions RELEASING.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,20 @@ Then cut it:
script/release patch
```

Append `--rc` to preview or cut a release candidate, for example
`script/release patch --rc`. Repeating the same bump increments `-rc.N`; omit
`--rc` to release the stable version.
To preview a release candidate instead:

```sh
RELEASE_DRY_RUN=1 script/release patch --rc
```

Then cut it:

```sh
script/release patch --rc
```

The first candidate is `go/vX.Y.Z-rc.1`; repeating the same bump increments
`rc.N`. Run the bump without `--rc` to publish the stable `go/vX.Y.Z`.

Use `patch` for compatible fixes, `minor` for compatible additions, and
`major` for breaking changes.
Expand All @@ -32,6 +43,9 @@ The script validates the repository, checks the current branch and
The tag workflow verifies the tag, then creates the GitHub Release and warms
the Go module proxy.

A pushed release tag is immutable. If publishing fails, fix the publisher and
run the release script again for the next RC; do not move or reuse the failed tag.

## Tag conventions

The Go sub-module uses path-prefixed semver tags, per Go's multi-module
Expand Down
Loading