Skip to content

Commit

Permalink
Add a few notes to release docs
Browse files Browse the repository at this point in the history
about the relationship to proxy.golang.org and automatically generated
release notes.
  • Loading branch information
meatballhat committed Sep 5, 2022
1 parent 31c5137 commit 49f6440
Showing 1 changed file with 8 additions and 4 deletions.
12 changes: 8 additions & 4 deletions docs/RELEASING.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,9 +41,11 @@ git tag -a -s -m 'Release 2.4.8' v2.4.8
git push origin v2.4.8
```

The tag push will trigger a GitHub Actions workflow. The remaining
steps require human intervention through the GitHub web view
although [automated solutions
The tag push will trigger a GitHub Actions workflow and will be
**immediately available** to the [Go module mirror, index, and
checksum database](https://proxy.golang.org/). The remaining steps
require human intervention through the GitHub web view although
[automated solutions
exist](https://github.com/softprops/action-gh-release) that may be
adopted in the future.

Expand All @@ -58,4 +60,6 @@ adopted in the future.

[^2]: This was not always true. The
[`docs/CHANGELOG.md`](./CHANGELOG.md) document used to be
manually maintained.
manually maintained. Relying on the automatic release notes
generation requires the use of **merge commits** as opposed to
squash merging or rebase merging.

0 comments on commit 49f6440

Please sign in to comment.