From 2c15ac99d93f4b383e584a3c7b5559ffcf8b0a38 Mon Sep 17 00:00:00 2001 From: Matt Fisher Date: Tue, 1 Oct 2024 12:28:47 -0600 Subject: [PATCH] Update releasing docs from run-through with Nikki Co-Authored-By: Nikki Tebaldi <17799906+nikki-t@users.noreply.github.com> --- docs/contributing/releasing.md | 23 +++++++++++++++++++---- 1 file changed, 19 insertions(+), 4 deletions(-) diff --git a/docs/contributing/releasing.md b/docs/contributing/releasing.md index fe62a000..ddc29dc4 100644 --- a/docs/contributing/releasing.md +++ b/docs/contributing/releasing.md @@ -3,7 +3,9 @@ > :memo: The versioning scheme we use is [SemVer](http://semver.org/). Note that until > we agree we're ready for v1.0.0, we will not increment the major version. -1. Ensure all desired features are merged to `main` branch and `CHANGELOG.md` is updated. +1. Ensure all desired features are merged to `main` branch and `CHANGELOG.md` is + updated. **Do not** edit the `[Unreleased]` header in the CHANGELOG -- the next step + will automatically update it. 1. Use `bump-my-version` to increase the version number in all needed places, e.g. to increase the minor version (`1.2.3` to `1.3.0`): @@ -11,12 +13,25 @@ bump-my-version bump minor ``` + Add, commit, and push the files changed by `bump-my-version`. 1. Push a tag on the new commit containing the version number, prefixed with `v`, e.g. `v1.3.0`. + + ```plain + git tag v1.3.0 # EXAMPLE version number + ``` + + > :memo: It's a good idea to use `git log`, e.g. `git log --decorate --oneline + > --pretty` to verify the tag is on the correct commit before pushing. + + ```plain + git push origin v1.3.0 # EXAMPLE version number + ``` 1. [Create a new GitHub Release](https://github.com/nsidc/earthaccess/releases/new). We - hand-curate our release notes to be valuable to humans. Please do not auto-generate - release notes and aim for consistency with the GitHub Release descriptions from other - releases. + hand-curate our release notes to be valuable to humans. Please auto-generate + release notes, but replace the "What's changed" section with the Markdown from the + new CHANGELOG section for this release. Retain the "New contributors" and "Full + changelog" text generated by GitHub. Ensure "Set as latest release" is checked. > :gear: After the GitHub release is published, multiple automations will trigger: >