Skip to content

Commit

Permalink
Document step to create a branch and PR when releasing (#950)
Browse files Browse the repository at this point in the history
  • Loading branch information
mfisher87 authored Feb 12, 2025
1 parent 34ffbe2 commit 74c0ef5
Showing 1 changed file with 16 additions and 24 deletions.
40 changes: 16 additions & 24 deletions docs/contributing/releasing.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,43 +6,35 @@
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. **Do not** edit the `Unreleased` header in the CHANGELOG -- the next step
will automatically update it.
updated. **Do not** edit the `Unreleased` header in the CHANGELOG -- that will be
handled automatically in a later step.

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`):
1. Create a new branch to make release changes. We do not permit pushing to `main` and
this will give the community visibility into release management activities.

1. Use `bump-my-version` to automatically increase the version number in all needed
places, for example to increase the minor version (`1.2.3` to `1.3.0`):

```plain
bump-my-version bump minor
```
Add, commit, and push the files changed by `bump-my-version`.
**Add, commit, and push the files changed by `bump-my-version`.**
!!! note
The files managed by `bump-my-version` are configured in `pyproject.toml`.
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
```
!!! tip
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.
1. Open a pull request with the changes. **Review, and merge.**
```plain
git push origin v1.3.0 # EXAMPLE version number
```
1. [Create a new GitHub Release](https://github.com/nsidc/earthaccess/releases/new).
In the "Choose a tag" dialog, enter a new tag prefixed with `v`, for example
`v1.3.0`.
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 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.
We 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.
!!! info
Expand Down

0 comments on commit 74c0ef5

Please sign in to comment.