From 2c15ac99d93f4b383e584a3c7b5559ffcf8b0a38 Mon Sep 17 00:00:00 2001 From: Matt Fisher Date: Tue, 1 Oct 2024 12:28:47 -0600 Subject: [PATCH 1/5] 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: > From b1b319e40a2c8c0791a4f405a5772c2a5f6dae5c Mon Sep 17 00:00:00 2001 From: Matt Fisher Date: Tue, 1 Oct 2024 12:44:39 -0600 Subject: [PATCH 2/5] Add conda-forge and install testing details --- docs/contributing/releasing.md | 21 +++++++++++++-------- 1 file changed, 13 insertions(+), 8 deletions(-) diff --git a/docs/contributing/releasing.md b/docs/contributing/releasing.md index ddc29dc4..6019fcd4 100644 --- a/docs/contributing/releasing.md +++ b/docs/contributing/releasing.md @@ -33,11 +33,16 @@ 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: -> -> - Zenodo will create a new DOI. -> - GitHub Actions will publish a PyPI release. - -> :memo: `earthaccess` is published to conda-forge through the -> [earthdata-feedstock](https://github.com/conda-forge/earthdata-feedstock), as this -> project was renamed early in its life. The conda package is named `earthaccess`. + > :gear: After the GitHub release is published, multiple automations will trigger: + > + > - Zenodo will create a new DOI. + > - GitHub Actions will publish a PyPI release. +1. Once the package is visible on PyPI, check it's installable with `pip install + earthaccess==vX.Y.Z`. +1. After the package is released on PyPI, follow the + [conda-forge maintainer process](https://conda-forge.org/docs/maintainer/) to release + the package on conda-forge. + + > :memo: `earthaccess` is published to conda-forge through the + > [earthdata-feedstock](https://github.com/conda-forge/earthdata-feedstock), as this + > project was renamed early in its life. The conda package is named `earthaccess`. From 452981b83c3868b212c5fbc5a2b625220340c093 Mon Sep 17 00:00:00 2001 From: Matt Fisher Date: Tue, 1 Oct 2024 21:11:54 -0600 Subject: [PATCH 3/5] Fix incorrect string in doc --- docs/contributing/releasing.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/contributing/releasing.md b/docs/contributing/releasing.md index 6019fcd4..5fd31fee 100644 --- a/docs/contributing/releasing.md +++ b/docs/contributing/releasing.md @@ -4,7 +4,7 @@ > 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 + 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`): From 3004088f88d87dd932ba7334fc748eacd51df6ec Mon Sep 17 00:00:00 2001 From: Matt Fisher Date: Wed, 2 Oct 2024 09:29:18 -0600 Subject: [PATCH 4/5] Add note about which files bump-my-version manages --- docs/contributing/releasing.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/contributing/releasing.md b/docs/contributing/releasing.md index 5fd31fee..2773bbfb 100644 --- a/docs/contributing/releasing.md +++ b/docs/contributing/releasing.md @@ -14,6 +14,11 @@ ``` 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`. From 5b84afcc07ea0b4798cbcb94d6029aa017f17d2a Mon Sep 17 00:00:00 2001 From: Matt Fisher Date: Wed, 2 Oct 2024 09:30:39 -0600 Subject: [PATCH 5/5] Fix indentation to correctly nest content within list elements Switch GitHub-style notes to Mkdocs admonitions --- docs/contributing/releasing.md | 53 ++++++++++++++++++++-------------- 1 file changed, 32 insertions(+), 21 deletions(-) diff --git a/docs/contributing/releasing.md b/docs/contributing/releasing.md index 2773bbfb..96f27e83 100644 --- a/docs/contributing/releasing.md +++ b/docs/contributing/releasing.md @@ -6,48 +6,59 @@ 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`): - ```plain - bump-my-version bump minor - ``` + ```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 + !!! note - The files managed by `bump-my-version` are configured in `pyproject.toml`. + 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 - ``` + ```plain + git tag v1.3.0 # EXAMPLE version number + ``` + + !!! tip - > :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. + 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 + ``` - ```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 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: - > - > - Zenodo will create a new DOI. - > - GitHub Actions will publish a PyPI release. + !!! info + + After the GitHub release is published, multiple automations will trigger: + + - Zenodo will create a new DOI. + - GitHub Actions will publish a PyPI release. + 1. Once the package is visible on PyPI, check it's installable with `pip install earthaccess==vX.Y.Z`. + 1. After the package is released on PyPI, follow the [conda-forge maintainer process](https://conda-forge.org/docs/maintainer/) to release the package on conda-forge. - > :memo: `earthaccess` is published to conda-forge through the - > [earthdata-feedstock](https://github.com/conda-forge/earthdata-feedstock), as this - > project was renamed early in its life. The conda package is named `earthaccess`. + !!! note + + :memo: `earthaccess` is published to conda-forge through the + [earthdata-feedstock](https://github.com/conda-forge/earthdata-feedstock), as + this project was renamed early in its life. The conda package is named + `earthaccess`.