summaryrefslogtreecommitdiffstats
path: root/.github/ISSUE_TEMPLATE/release-checklist.md
diff options
context:
space:
mode:
Diffstat (limited to '.github/ISSUE_TEMPLATE/release-checklist.md')
-rw-r--r--.github/ISSUE_TEMPLATE/release-checklist.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/.github/ISSUE_TEMPLATE/release-checklist.md b/.github/ISSUE_TEMPLATE/release-checklist.md
new file mode 100644
index 0000000..323c724
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/release-checklist.md
@@ -0,0 +1,19 @@
+---
+# Template generated by https://github.com/coreos/repo-templates; do not edit downstream
+---
+
+Release checklist:
+
+Tagging:
+ - [ ] Write release notes in `docs/release-notes.md`. Get them reviewed and merged
+ - [ ] If doing a branched release, also include a PR to merge the `docs/release-notes.md` changes into main
+ - [ ] Ensure your local copy is up to date with the upstream main branch (`git@github.com:coreos/stream-metadata-go.git`)
+ - [ ] Ensure your working directory is clean (`git clean -fdx`)
+ - [ ] Ensure you can sign commits and any yubikeys/smartcards are plugged in
+ - [ ] Run `./tag_release.sh <vX.Y.z> <git commit hash>`
+ - [ ] Push that tag to GitHub
+
+GitHub release:
+ - [ ] Find the new tag in the [GitHub tag list](https://github.com/coreos/stream-metadata-go/tags) and click the triple dots menu, and create a draft release for it.
+ - [ ] Copy and paste the release notes from `docs/release-notes.md`
+ - [ ] Publish the release