From 11d7bb775cf8343f8de4a92a6200ff95ae9cc4dc Mon Sep 17 00:00:00 2001 From: Richard Gibson Date: Tue, 16 Apr 2024 14:46:50 -0400 Subject: [PATCH] docs(MAINTAINERS): Document use of gen-github-release.sh --- MAINTAINERS.md | 18 ++++++++++++++---- 1 file changed, 14 insertions(+), 4 deletions(-) diff --git a/MAINTAINERS.md b/MAINTAINERS.md index 659876c2dceb..acee371125ae 100644 --- a/MAINTAINERS.md +++ b/MAINTAINERS.md @@ -222,10 +222,20 @@ to pass. - [ ] Create a GitHub release - Follow the [GitHub - instructions](https://docs.github.com/en/repositories/releasing-projects-on-github/managing-releases-in-a-repository - ) and use previous releases as a template. This uses the - validator-oriented release description. + Generate a template: + ```sh + ./scripts/gen-github-release > release.md + ``` + Then replace the remaining `$`-prefixed placeholders, filling in + the validator-oriented release description and using + [previous releases](https://github.com/Agoric/agoric-sdk/releases) + as a guide. + When complete, contents can be pasted into the + [new release form](https://github.com/Agoric/agoric-sdk/releases/new) + along with the just-pushed tag and an identically-named title. + + For more information, refer to + [GitHub instructions](https://docs.github.com/en/repositories/releasing-projects-on-github/managing-releases-in-a-repository). ### Cleanup