|
6 | 6 | we agree we're ready for v1.0.0, we will not increment the major version.
|
7 | 7 |
|
8 | 8 | 1. Ensure all desired features are merged to `main` branch and `CHANGELOG.md` is
|
9 |
| - updated. **Do not** edit the `Unreleased` header in the CHANGELOG -- the next step |
10 |
| - will automatically update it. |
| 9 | + updated. **Do not** edit the `Unreleased` header in the CHANGELOG -- that will be |
| 10 | + handled automatically in a later step. |
11 | 11 |
|
12 |
| -1. Use `bump-my-version` to increase the version number in all needed places, e.g. to |
13 |
| - increase the minor version (`1.2.3` to `1.3.0`): |
| 12 | +1. Create a new branch to make release changes. We do not permit pushing to `main` and |
| 13 | + this will give the community visibility into release management activities. |
| 14 | + |
| 15 | +1. Use `bump-my-version` to automatically increase the version number in all needed |
| 16 | + places, for example to increase the minor version (`1.2.3` to `1.3.0`): |
14 | 17 |
|
15 | 18 | ```plain
|
16 | 19 | bump-my-version bump minor
|
17 | 20 | ```
|
18 | 21 |
|
19 |
| - Add, commit, and push the files changed by `bump-my-version`. |
| 22 | + **Add, commit, and push the files changed by `bump-my-version`.** |
20 | 23 |
|
21 | 24 | !!! note
|
22 | 25 |
|
23 | 26 | The files managed by `bump-my-version` are configured in `pyproject.toml`.
|
24 | 27 |
|
25 |
| -1. Push a tag on the new commit containing the version number, prefixed with `v`, e.g. |
26 |
| - `v1.3.0`. |
27 |
| -
|
28 |
| - ```plain |
29 |
| - git tag v1.3.0 # EXAMPLE version number |
30 |
| - ``` |
31 |
| -
|
32 |
| - !!! tip |
33 |
| -
|
34 |
| - It's a good idea to use `git log`, e.g. `git log --decorate --oneline |
35 |
| - --pretty` to verify the tag is on the correct commit before pushing. |
| 28 | +1. Open a pull request with the changes. **Review, and merge.** |
36 | 29 |
|
37 |
| - ```plain |
38 |
| - git push origin v1.3.0 # EXAMPLE version number |
39 |
| - ``` |
| 30 | +1. [Create a new GitHub Release](https://github.com/nsidc/earthaccess/releases/new). |
| 31 | + In the "Choose a tag" dialog, enter a new tag prefixed with `v`, for example |
| 32 | + `v1.3.0`. |
40 | 33 |
|
41 |
| -1. [Create a new GitHub Release](https://github.com/nsidc/earthaccess/releases/new). We |
42 |
| - hand-curate our release notes to be valuable to humans. Please auto-generate |
43 |
| - release notes, but replace the "What's changed" section with the Markdown from the |
44 |
| - new CHANGELOG section for this release. Retain the "New contributors" and "Full |
45 |
| - changelog" text generated by GitHub. Ensure "Set as latest release" is checked. |
| 34 | + We hand-curate our release notes to be valuable to humans. Please auto-generate release |
| 35 | + notes, but replace the "What's changed" section with the Markdown from the new CHANGELOG |
| 36 | + section for this release. Retain the "New contributors" and "Full changelog" text |
| 37 | + generated by GitHub. Ensure "Set as latest release" is checked. |
46 | 38 |
|
47 | 39 | !!! info
|
48 | 40 |
|
|
0 commit comments