From 49f6440a18c8f79befcd80188e0cc8d49201c359 Mon Sep 17 00:00:00 2001 From: Dan Buch Date: Mon, 5 Sep 2022 12:03:38 -0400 Subject: [PATCH] Add a few notes to release docs about the relationship to proxy.golang.org and automatically generated release notes. --- docs/RELEASING.md | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/docs/RELEASING.md b/docs/RELEASING.md index b10e4e0dbf..079791b611 100644 --- a/docs/RELEASING.md +++ b/docs/RELEASING.md @@ -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. @@ -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.