From c09cd2487f519a98d7a7579e1ebaf0110e3d35f7 Mon Sep 17 00:00:00 2001 From: Dongdong Tian Date: Mon, 5 Aug 2024 11:07:41 +0800 Subject: [PATCH 01/21] Move spelling check to the end of the list --- .github/ISSUE_TEMPLATE/4-release_checklist.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/4-release_checklist.md b/.github/ISSUE_TEMPLATE/4-release_checklist.md index 12dde7459b6..031c1196d9c 100644 --- a/.github/ISSUE_TEMPLATE/4-release_checklist.md +++ b/.github/ISSUE_TEMPLATE/4-release_checklist.md @@ -17,7 +17,6 @@ assignees: '' **Before release**: - [ ] Check [SPEC 0](https://scientific-python.org/specs/spec-0000/) to see if we need to bump the minimum supported versions of GMT, Python and core package dependencies (NumPy/Pandas/Xarray) -- [ ] Run `make codespell` to check common misspellings. If there are any, either fix them or add them to `ignore-words-list` in `pyproject.toml` - [ ] Check to ensure that: - [ ] All tests pass in the ["GMT Legacy Tests" workflow](https://github.com/GenericMappingTools/pygmt/actions/workflows/ci_tests_legacy.yaml) - [ ] All tests pass in the ["GMT Dev Tests" workflow](https://github.com/GenericMappingTools/pygmt/actions/workflows/ci_tests_dev.yaml) @@ -37,6 +36,7 @@ assignees: '' - [ ] Add the documentation link `doc/minversions.md` - [ ] Add minimum required version information `doc/minversions.md` - [ ] Copy draft changelog from Release Drafter and edit it to look nice ([see maintainers guide for details](https://www.pygmt.org/dev/maintenance.html#updating-the-changelog)) +- [ ] Run `make codespell` to check common misspellings. If there are any, either fix them or add them to `ignore-words-list` in `pyproject.toml` **Release**: - [ ] At the [PyGMT release page on GitHub](https://github.com/GenericMappingTools/pygmt/releases): From 30c081f0075c89390ca4704f4307b12a58374b19 Mon Sep 17 00:00:00 2001 From: Dongdong Tian Date: Mon, 5 Aug 2024 11:07:56 +0800 Subject: [PATCH 02/21] Fix a typo --- .github/ISSUE_TEMPLATE/4-release_checklist.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/4-release_checklist.md b/.github/ISSUE_TEMPLATE/4-release_checklist.md index 031c1196d9c..fd34fd13a32 100644 --- a/.github/ISSUE_TEMPLATE/4-release_checklist.md +++ b/.github/ISSUE_TEMPLATE/4-release_checklist.md @@ -23,7 +23,7 @@ assignees: '' - [ ] All tests pass in the ["Doctests" workflow](https://github.com/GenericMappingTools/pygmt/actions/workflows/ci_doctests.yaml) - [ ] Deprecations and related tests are removed for this version by running `grep --include="*.py" -r 'remove_version="vX.Y.Z"' pygmt` from the base of the repository - [ ] Update warnings in `pygmt.show_versions()` as well as notes in [Common installation issues](https://www.pygmt.org/dev/install.html#not-working-transparency) - and [Testing your install]((https://www.pygmt.org/dev/install.html#testing-your-install) regarding GMT-Ghostscript incompatibility + and [Testing your install](https://www.pygmt.org/dev/install.html#testing-your-install) regarding GMT-Ghostscript incompatibility - [ ] Reserve a DOI on [Zenodo](https://zenodo.org) by clicking on "New Version" - [ ] Review the ["PyGMT Team" page](https://www.pygmt.org/dev/team.html) - [ ] Finish up 'Changelog entry for v0.x.x' Pull Request: From ad5fffd2483964e8aa3b9f02e6af3276f23c2bd5 Mon Sep 17 00:00:00 2001 From: Dongdong Tian Date: Mon, 5 Aug 2024 11:13:42 +0800 Subject: [PATCH 03/21] GMT-GS compatability is not in a new separate subsection --- .github/ISSUE_TEMPLATE/4-release_checklist.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/4-release_checklist.md b/.github/ISSUE_TEMPLATE/4-release_checklist.md index fd34fd13a32..19276732a2d 100644 --- a/.github/ISSUE_TEMPLATE/4-release_checklist.md +++ b/.github/ISSUE_TEMPLATE/4-release_checklist.md @@ -22,8 +22,9 @@ assignees: '' - [ ] All tests pass in the ["GMT Dev Tests" workflow](https://github.com/GenericMappingTools/pygmt/actions/workflows/ci_tests_dev.yaml) - [ ] All tests pass in the ["Doctests" workflow](https://github.com/GenericMappingTools/pygmt/actions/workflows/ci_doctests.yaml) - [ ] Deprecations and related tests are removed for this version by running `grep --include="*.py" -r 'remove_version="vX.Y.Z"' pygmt` from the base of the repository -- [ ] Update warnings in `pygmt.show_versions()` as well as notes in [Common installation issues](https://www.pygmt.org/dev/install.html#not-working-transparency) - and [Testing your install](https://www.pygmt.org/dev/install.html#testing-your-install) regarding GMT-Ghostscript incompatibility +- [ ] Update warnings in `pygmt/_show_versions.py` as well as notes in + [Not working transparency](https://www.pygmt.org/dev/install.html#not-working-transparency) + regarding GMT-Ghostscript incompatibility - [ ] Reserve a DOI on [Zenodo](https://zenodo.org) by clicking on "New Version" - [ ] Review the ["PyGMT Team" page](https://www.pygmt.org/dev/team.html) - [ ] Finish up 'Changelog entry for v0.x.x' Pull Request: From 13961dce1033db55ae69918cedfae4dcfd15d9e4 Mon Sep 17 00:00:00 2001 From: Dongdong Tian Date: Mon, 5 Aug 2024 11:17:24 +0800 Subject: [PATCH 04/21] Remove deprecated codes first before checking other CI workflows --- .github/ISSUE_TEMPLATE/4-release_checklist.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/4-release_checklist.md b/.github/ISSUE_TEMPLATE/4-release_checklist.md index 19276732a2d..e5fc593c2e6 100644 --- a/.github/ISSUE_TEMPLATE/4-release_checklist.md +++ b/.github/ISSUE_TEMPLATE/4-release_checklist.md @@ -18,10 +18,10 @@ assignees: '' **Before release**: - [ ] Check [SPEC 0](https://scientific-python.org/specs/spec-0000/) to see if we need to bump the minimum supported versions of GMT, Python and core package dependencies (NumPy/Pandas/Xarray) - [ ] Check to ensure that: + - [ ] Deprecations and related tests are removed for this version by running `grep --include="*.py" -r 'remove_version="vX.Y.Z"' pygmt` from the base of the repository - [ ] All tests pass in the ["GMT Legacy Tests" workflow](https://github.com/GenericMappingTools/pygmt/actions/workflows/ci_tests_legacy.yaml) - [ ] All tests pass in the ["GMT Dev Tests" workflow](https://github.com/GenericMappingTools/pygmt/actions/workflows/ci_tests_dev.yaml) - [ ] All tests pass in the ["Doctests" workflow](https://github.com/GenericMappingTools/pygmt/actions/workflows/ci_doctests.yaml) - - [ ] Deprecations and related tests are removed for this version by running `grep --include="*.py" -r 'remove_version="vX.Y.Z"' pygmt` from the base of the repository - [ ] Update warnings in `pygmt/_show_versions.py` as well as notes in [Not working transparency](https://www.pygmt.org/dev/install.html#not-working-transparency) regarding GMT-Ghostscript incompatibility From ea7c25d764c3741b2209a55f0194890edaf3a130 Mon Sep 17 00:00:00 2001 From: Dongdong Tian Date: Mon, 5 Aug 2024 11:19:24 +0800 Subject: [PATCH 05/21] Add a entry to check pre-commit hooks --- .github/ISSUE_TEMPLATE/4-release_checklist.md | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/ISSUE_TEMPLATE/4-release_checklist.md b/.github/ISSUE_TEMPLATE/4-release_checklist.md index e5fc593c2e6..9b39694d2a7 100644 --- a/.github/ISSUE_TEMPLATE/4-release_checklist.md +++ b/.github/ISSUE_TEMPLATE/4-release_checklist.md @@ -17,6 +17,7 @@ assignees: '' **Before release**: - [ ] Check [SPEC 0](https://scientific-python.org/specs/spec-0000/) to see if we need to bump the minimum supported versions of GMT, Python and core package dependencies (NumPy/Pandas/Xarray) +- [ ] Check repositories in `.pre-commit-config.yaml` and see if there are new versions for the pre-commit hooks - [ ] Check to ensure that: - [ ] Deprecations and related tests are removed for this version by running `grep --include="*.py" -r 'remove_version="vX.Y.Z"' pygmt` from the base of the repository - [ ] All tests pass in the ["GMT Legacy Tests" workflow](https://github.com/GenericMappingTools/pygmt/actions/workflows/ci_tests_legacy.yaml) From 4470f96cf98baa247413977e21f9ac568961858c Mon Sep 17 00:00:00 2001 From: Dongdong Tian Date: Mon, 5 Aug 2024 11:25:21 +0800 Subject: [PATCH 06/21] Draft the announcement before the release --- .github/ISSUE_TEMPLATE/4-release_checklist.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/4-release_checklist.md b/.github/ISSUE_TEMPLATE/4-release_checklist.md index 9b39694d2a7..3ff8dcf1cca 100644 --- a/.github/ISSUE_TEMPLATE/4-release_checklist.md +++ b/.github/ISSUE_TEMPLATE/4-release_checklist.md @@ -38,6 +38,7 @@ assignees: '' - [ ] Add the documentation link `doc/minversions.md` - [ ] Add minimum required version information `doc/minversions.md` - [ ] Copy draft changelog from Release Drafter and edit it to look nice ([see maintainers guide for details](https://www.pygmt.org/dev/maintenance.html#updating-the-changelog)) +- [ ] Draft the announcement on https://hackmd.io/@pygmt - [ ] Run `make codespell` to check common misspellings. If there are any, either fix them or add them to `ignore-words-list` in `pyproject.toml` **Release**: @@ -51,7 +52,7 @@ assignees: '' - [ ] Update conda-forge [pygmt-feedstock](https://github.com/conda-forge/pygmt-feedstock) [Done automatically by conda-forge's bot, but remember to pin SPEC0 versions] - [ ] Bump PyGMT version on https://github.com/GenericMappingTools/try-gmt (after conda-forge update) - [ ] Announce the release on: - - [ ] GMT [forum](https://forum.generic-mapping-tools.org/c/news/) (do this announcement first! draft on https://hackmd.io/@pygmt. requires moderator status) + - [ ] GMT [forum](https://forum.generic-mapping-tools.org/c/news/) (do this announcement first! requires moderator status) - [ ] [ResearchGate](https://www.researchgate.net) (after forum announcement, add new version as research item via the **code** category, be sure to include the corresponding new Zenodo DOI) --- From 7316504b6444301e067dc57ee6c417459a01204a Mon Sep 17 00:00:00 2001 From: Dongdong Tian Date: Mon, 5 Aug 2024 15:34:57 +0800 Subject: [PATCH 07/21] Typo Co-authored-by: Michael Grund <23025878+michaelgrund@users.noreply.github.com> --- .github/ISSUE_TEMPLATE/4-release_checklist.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/4-release_checklist.md b/.github/ISSUE_TEMPLATE/4-release_checklist.md index 3ff8dcf1cca..e2be1c5c7b1 100644 --- a/.github/ISSUE_TEMPLATE/4-release_checklist.md +++ b/.github/ISSUE_TEMPLATE/4-release_checklist.md @@ -52,7 +52,7 @@ assignees: '' - [ ] Update conda-forge [pygmt-feedstock](https://github.com/conda-forge/pygmt-feedstock) [Done automatically by conda-forge's bot, but remember to pin SPEC0 versions] - [ ] Bump PyGMT version on https://github.com/GenericMappingTools/try-gmt (after conda-forge update) - [ ] Announce the release on: - - [ ] GMT [forum](https://forum.generic-mapping-tools.org/c/news/) (do this announcement first! requires moderator status) + - [ ] GMT [forum](https://forum.generic-mapping-tools.org/c/news/) (do this announcement first! Requires moderator status) - [ ] [ResearchGate](https://www.researchgate.net) (after forum announcement, add new version as research item via the **code** category, be sure to include the corresponding new Zenodo DOI) --- From bbda6c2fde7c6deb55f9c743b08dd127091ee31e Mon Sep 17 00:00:00 2001 From: Dongdong Tian Date: Tue, 6 Aug 2024 06:42:19 +0800 Subject: [PATCH 08/21] Update .github/ISSUE_TEMPLATE/4-release_checklist.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Yvonne Fröhlich <94163266+yvonnefroehlich@users.noreply.github.com> --- .github/ISSUE_TEMPLATE/4-release_checklist.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/4-release_checklist.md b/.github/ISSUE_TEMPLATE/4-release_checklist.md index e2be1c5c7b1..4f212ef3fcd 100644 --- a/.github/ISSUE_TEMPLATE/4-release_checklist.md +++ b/.github/ISSUE_TEMPLATE/4-release_checklist.md @@ -28,7 +28,7 @@ assignees: '' regarding GMT-Ghostscript incompatibility - [ ] Reserve a DOI on [Zenodo](https://zenodo.org) by clicking on "New Version" - [ ] Review the ["PyGMT Team" page](https://www.pygmt.org/dev/team.html) -- [ ] Finish up 'Changelog entry for v0.x.x' Pull Request: +- [ ] Finish up the "Changelog entry for v0.x.x" Pull Request: - [ ] Add a new entry in `doc/_static/version_switch.js` for documentation switcher - [ ] Update `CITATION.cff` and BibTeX at https://github.com/GenericMappingTools/pygmt#citing-pygmt - [ ] Update authorship list From fcfe59d93da30e172aa0340a61af60ede6da0224 Mon Sep 17 00:00:00 2001 From: Dongdong Tian Date: Wed, 7 Aug 2024 15:32:30 +0800 Subject: [PATCH 09/21] Review the PyGMT team page earlier since it may take some time --- .github/ISSUE_TEMPLATE/4-release_checklist.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/4-release_checklist.md b/.github/ISSUE_TEMPLATE/4-release_checklist.md index 4f212ef3fcd..64aa0a94979 100644 --- a/.github/ISSUE_TEMPLATE/4-release_checklist.md +++ b/.github/ISSUE_TEMPLATE/4-release_checklist.md @@ -18,6 +18,7 @@ assignees: '' **Before release**: - [ ] Check [SPEC 0](https://scientific-python.org/specs/spec-0000/) to see if we need to bump the minimum supported versions of GMT, Python and core package dependencies (NumPy/Pandas/Xarray) - [ ] Check repositories in `.pre-commit-config.yaml` and see if there are new versions for the pre-commit hooks +- [ ] Review the ["PyGMT Team" page](https://www.pygmt.org/dev/team.html) - [ ] Check to ensure that: - [ ] Deprecations and related tests are removed for this version by running `grep --include="*.py" -r 'remove_version="vX.Y.Z"' pygmt` from the base of the repository - [ ] All tests pass in the ["GMT Legacy Tests" workflow](https://github.com/GenericMappingTools/pygmt/actions/workflows/ci_tests_legacy.yaml) @@ -27,7 +28,6 @@ assignees: '' [Not working transparency](https://www.pygmt.org/dev/install.html#not-working-transparency) regarding GMT-Ghostscript incompatibility - [ ] Reserve a DOI on [Zenodo](https://zenodo.org) by clicking on "New Version" -- [ ] Review the ["PyGMT Team" page](https://www.pygmt.org/dev/team.html) - [ ] Finish up the "Changelog entry for v0.x.x" Pull Request: - [ ] Add a new entry in `doc/_static/version_switch.js` for documentation switcher - [ ] Update `CITATION.cff` and BibTeX at https://github.com/GenericMappingTools/pygmt#citing-pygmt From aff71d2fb406a9cd0ac33026d19d69bb129fb236 Mon Sep 17 00:00:00 2001 From: Dongdong Tian Date: Tue, 27 Aug 2024 17:38:41 +0800 Subject: [PATCH 10/21] No need to check hooks manually after enabling pre-commit.ci --- .github/ISSUE_TEMPLATE/4-release_checklist.md | 1 - 1 file changed, 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/4-release_checklist.md b/.github/ISSUE_TEMPLATE/4-release_checklist.md index 64aa0a94979..983095fdaab 100644 --- a/.github/ISSUE_TEMPLATE/4-release_checklist.md +++ b/.github/ISSUE_TEMPLATE/4-release_checklist.md @@ -17,7 +17,6 @@ assignees: '' **Before release**: - [ ] Check [SPEC 0](https://scientific-python.org/specs/spec-0000/) to see if we need to bump the minimum supported versions of GMT, Python and core package dependencies (NumPy/Pandas/Xarray) -- [ ] Check repositories in `.pre-commit-config.yaml` and see if there are new versions for the pre-commit hooks - [ ] Review the ["PyGMT Team" page](https://www.pygmt.org/dev/team.html) - [ ] Check to ensure that: - [ ] Deprecations and related tests are removed for this version by running `grep --include="*.py" -r 'remove_version="vX.Y.Z"' pygmt` from the base of the repository From 12a2011d0cde2db242100488ba084bcde36feb8a Mon Sep 17 00:00:00 2001 From: Dongdong Tian Date: Wed, 4 Sep 2024 14:35:51 +0800 Subject: [PATCH 11/21] Show DOI at the top --- .github/ISSUE_TEMPLATE/4-release_checklist.md | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/ISSUE_TEMPLATE/4-release_checklist.md b/.github/ISSUE_TEMPLATE/4-release_checklist.md index 983095fdaab..8cd824ba97f 100644 --- a/.github/ISSUE_TEMPLATE/4-release_checklist.md +++ b/.github/ISSUE_TEMPLATE/4-release_checklist.md @@ -10,6 +10,7 @@ assignees: '' **Release**: [v0.x.x](https://github.com/GenericMappingTools/pygmt/milestones/?) **Scheduled Date**: YYYY/MM/DD **Pull request due date**: YYYY/MM/DD +**DOI**: **Priority PRs/issues to complete prior to release** - [ ] Wrap X () From 55f27eb481ceb10349c36b468d122b9900bcfcae Mon Sep 17 00:00:00 2001 From: Dongdong Tian Date: Thu, 5 Sep 2024 09:45:41 +0800 Subject: [PATCH 12/21] Simplify the checklist for changelog entry --- .github/ISSUE_TEMPLATE/4-release_checklist.md | 15 +++------------ 1 file changed, 3 insertions(+), 12 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/4-release_checklist.md b/.github/ISSUE_TEMPLATE/4-release_checklist.md index 8cd824ba97f..2a3a51debc2 100644 --- a/.github/ISSUE_TEMPLATE/4-release_checklist.md +++ b/.github/ISSUE_TEMPLATE/4-release_checklist.md @@ -4,13 +4,12 @@ about: Checklist for a new PyGMT release. title: Release PyGMT vX.Y.Z labels: maintenance assignees: '' - --- **Release**: [v0.x.x](https://github.com/GenericMappingTools/pygmt/milestones/?) **Scheduled Date**: YYYY/MM/DD **Pull request due date**: YYYY/MM/DD -**DOI**: +**DOI**: `10.5281/zenodo.XXXXXXX` **Priority PRs/issues to complete prior to release** - [ ] Wrap X () @@ -28,16 +27,7 @@ assignees: '' [Not working transparency](https://www.pygmt.org/dev/install.html#not-working-transparency) regarding GMT-Ghostscript incompatibility - [ ] Reserve a DOI on [Zenodo](https://zenodo.org) by clicking on "New Version" -- [ ] Finish up the "Changelog entry for v0.x.x" Pull Request: - - [ ] Add a new entry in `doc/_static/version_switch.js` for documentation switcher - - [ ] Update `CITATION.cff` and BibTeX at https://github.com/GenericMappingTools/pygmt#citing-pygmt - - [ ] Update authorship list - - [ ] Update DOI (and url for BibTeX) - - [ ] Update version - - [ ] Update date released - - [ ] Add the documentation link `doc/minversions.md` - - [ ] Add minimum required version information `doc/minversions.md` - - [ ] Copy draft changelog from Release Drafter and edit it to look nice ([see maintainers guide for details](https://www.pygmt.org/dev/maintenance.html#updating-the-changelog)) +- [ ] Finish up the "Changelog entry for v0.x.x" Pull Request (Use the previous changelog PR as a reference) - [ ] Draft the announcement on https://hackmd.io/@pygmt - [ ] Run `make codespell` to check common misspellings. If there are any, either fix them or add them to `ignore-words-list` in `pyproject.toml` @@ -54,6 +44,7 @@ assignees: '' - [ ] Announce the release on: - [ ] GMT [forum](https://forum.generic-mapping-tools.org/c/news/) (do this announcement first! Requires moderator status) - [ ] [ResearchGate](https://www.researchgate.net) (after forum announcement, add new version as research item via the **code** category, be sure to include the corresponding new Zenodo DOI) + --- - [ ] Party :tada: (don't tick before all other checkboxes are ticked!) From fcfd34a2c6fbc87ad2908b762e58e7aadf666bfd Mon Sep 17 00:00:00 2001 From: Dongdong Tian Date: Thu, 5 Sep 2024 15:50:47 +0800 Subject: [PATCH 13/21] Update the command to check deprecations in this version --- .github/ISSUE_TEMPLATE/4-release_checklist.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/4-release_checklist.md b/.github/ISSUE_TEMPLATE/4-release_checklist.md index 2a3a51debc2..ff35f3f7630 100644 --- a/.github/ISSUE_TEMPLATE/4-release_checklist.md +++ b/.github/ISSUE_TEMPLATE/4-release_checklist.md @@ -4,6 +4,7 @@ about: Checklist for a new PyGMT release. title: Release PyGMT vX.Y.Z labels: maintenance assignees: '' + --- **Release**: [v0.x.x](https://github.com/GenericMappingTools/pygmt/milestones/?) @@ -12,14 +13,16 @@ assignees: '' **DOI**: `10.5281/zenodo.XXXXXXX` **Priority PRs/issues to complete prior to release** + - [ ] Wrap X () - [ ] Wrap Y () **Before release**: + - [ ] Check [SPEC 0](https://scientific-python.org/specs/spec-0000/) to see if we need to bump the minimum supported versions of GMT, Python and core package dependencies (NumPy/Pandas/Xarray) - [ ] Review the ["PyGMT Team" page](https://www.pygmt.org/dev/team.html) - [ ] Check to ensure that: - - [ ] Deprecations and related tests are removed for this version by running `grep --include="*.py" -r 'remove_version="vX.Y.Z"' pygmt` from the base of the repository + - [ ] Deprecations and related tests are removed for this version by running `grep --include="*.py" -r vX.Y.Z` from the base of the repository - [ ] All tests pass in the ["GMT Legacy Tests" workflow](https://github.com/GenericMappingTools/pygmt/actions/workflows/ci_tests_legacy.yaml) - [ ] All tests pass in the ["GMT Dev Tests" workflow](https://github.com/GenericMappingTools/pygmt/actions/workflows/ci_tests_dev.yaml) - [ ] All tests pass in the ["Doctests" workflow](https://github.com/GenericMappingTools/pygmt/actions/workflows/ci_doctests.yaml) @@ -32,6 +35,7 @@ assignees: '' - [ ] Run `make codespell` to check common misspellings. If there are any, either fix them or add them to `ignore-words-list` in `pyproject.toml` **Release**: + - [ ] At the [PyGMT release page on GitHub](https://github.com/GenericMappingTools/pygmt/releases): - [ ] Edit the draft release notes with the finalized changelog - [ ] Set the tag version and release title to vX.Y.Z @@ -39,6 +43,7 @@ assignees: '' - [ ] Manually upload the pygmt-vX.Y.Z.zip and baseline-images.zip files to https://zenodo.org/deposit, ensure that it is filed under the correct reserved DOI **After release**: + - [ ] Update conda-forge [pygmt-feedstock](https://github.com/conda-forge/pygmt-feedstock) [Done automatically by conda-forge's bot, but remember to pin SPEC0 versions] - [ ] Bump PyGMT version on https://github.com/GenericMappingTools/try-gmt (after conda-forge update) - [ ] Announce the release on: From a4af06ea017a2673929aa993d05202e3c7be2d27 Mon Sep 17 00:00:00 2001 From: Dongdong Tian Date: Thu, 5 Sep 2024 20:05:52 +0800 Subject: [PATCH 14/21] Create a discussion for this release --- .github/ISSUE_TEMPLATE/4-release_checklist.md | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/ISSUE_TEMPLATE/4-release_checklist.md b/.github/ISSUE_TEMPLATE/4-release_checklist.md index ff35f3f7630..4cfb7c0c2f4 100644 --- a/.github/ISSUE_TEMPLATE/4-release_checklist.md +++ b/.github/ISSUE_TEMPLATE/4-release_checklist.md @@ -39,6 +39,7 @@ assignees: '' - [ ] At the [PyGMT release page on GitHub](https://github.com/GenericMappingTools/pygmt/releases): - [ ] Edit the draft release notes with the finalized changelog - [ ] Set the tag version and release title to vX.Y.Z + - [ ] Make sure "Set as the latests release" and "Create a discussion for this release" are selected - [ ] Make a release by clicking the 'Publish Release' button, this will automatically create a tag too - [ ] Manually upload the pygmt-vX.Y.Z.zip and baseline-images.zip files to https://zenodo.org/deposit, ensure that it is filed under the correct reserved DOI From a996ec98661c922f177ef516d94d05a428ba9172 Mon Sep 17 00:00:00 2001 From: Dongdong Tian Date: Thu, 5 Sep 2024 20:18:06 +0800 Subject: [PATCH 15/21] Check spelling before drafting annoucement --- .github/ISSUE_TEMPLATE/4-release_checklist.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/4-release_checklist.md b/.github/ISSUE_TEMPLATE/4-release_checklist.md index 4cfb7c0c2f4..14366204d54 100644 --- a/.github/ISSUE_TEMPLATE/4-release_checklist.md +++ b/.github/ISSUE_TEMPLATE/4-release_checklist.md @@ -31,8 +31,8 @@ assignees: '' regarding GMT-Ghostscript incompatibility - [ ] Reserve a DOI on [Zenodo](https://zenodo.org) by clicking on "New Version" - [ ] Finish up the "Changelog entry for v0.x.x" Pull Request (Use the previous changelog PR as a reference) -- [ ] Draft the announcement on https://hackmd.io/@pygmt - [ ] Run `make codespell` to check common misspellings. If there are any, either fix them or add them to `ignore-words-list` in `pyproject.toml` +- [ ] Draft the announcement on https://hackmd.io/@pygmt **Release**: From a6e3e982fe10a77c171559a24517f0a0897a3959 Mon Sep 17 00:00:00 2001 From: Dongdong Tian Date: Thu, 5 Sep 2024 23:15:14 +0800 Subject: [PATCH 16/21] Add instructions to trigger conda-forge's update manually --- .github/ISSUE_TEMPLATE/4-release_checklist.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/4-release_checklist.md b/.github/ISSUE_TEMPLATE/4-release_checklist.md index 14366204d54..9022e1819af 100644 --- a/.github/ISSUE_TEMPLATE/4-release_checklist.md +++ b/.github/ISSUE_TEMPLATE/4-release_checklist.md @@ -45,7 +45,8 @@ assignees: '' **After release**: -- [ ] Update conda-forge [pygmt-feedstock](https://github.com/conda-forge/pygmt-feedstock) [Done automatically by conda-forge's bot, but remember to pin SPEC0 versions] +- [ ] Update conda-forge [pygmt-feedstock](https://github.com/conda-forge/pygmt-feedstock) + [Done automatically by conda-forge's bot, but can also be triggered manually by openning an issue with the title `@conda-forge-admin, please update version`. Remember to pin SPEC0 versions] - [ ] Bump PyGMT version on https://github.com/GenericMappingTools/try-gmt (after conda-forge update) - [ ] Announce the release on: - [ ] GMT [forum](https://forum.generic-mapping-tools.org/c/news/) (do this announcement first! Requires moderator status) From d809f742263a1b4e3bc49e8f4be9ef2fe224e428 Mon Sep 17 00:00:00 2001 From: Dongdong Tian Date: Thu, 5 Sep 2024 23:16:33 +0800 Subject: [PATCH 17/21] Fix a typo --- .github/ISSUE_TEMPLATE/4-release_checklist.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/4-release_checklist.md b/.github/ISSUE_TEMPLATE/4-release_checklist.md index 9022e1819af..76cbdfa6a8d 100644 --- a/.github/ISSUE_TEMPLATE/4-release_checklist.md +++ b/.github/ISSUE_TEMPLATE/4-release_checklist.md @@ -46,7 +46,7 @@ assignees: '' **After release**: - [ ] Update conda-forge [pygmt-feedstock](https://github.com/conda-forge/pygmt-feedstock) - [Done automatically by conda-forge's bot, but can also be triggered manually by openning an issue with the title `@conda-forge-admin, please update version`. Remember to pin SPEC0 versions] + [Done automatically by conda-forge's bot, but can also be triggered manually by opening an issue with the title `@conda-forge-admin, please update version`. Remember to pin SPEC0 versions] - [ ] Bump PyGMT version on https://github.com/GenericMappingTools/try-gmt (after conda-forge update) - [ ] Announce the release on: - [ ] GMT [forum](https://forum.generic-mapping-tools.org/c/news/) (do this announcement first! Requires moderator status) From 2d979e21ae87565614582888ff741d6b2f1d0fc4 Mon Sep 17 00:00:00 2001 From: Dongdong Tian Date: Fri, 6 Sep 2024 11:03:22 +0800 Subject: [PATCH 18/21] Need to rename the zip file before uploading --- .github/ISSUE_TEMPLATE/4-release_checklist.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/4-release_checklist.md b/.github/ISSUE_TEMPLATE/4-release_checklist.md index 76cbdfa6a8d..beed0a8fb17 100644 --- a/.github/ISSUE_TEMPLATE/4-release_checklist.md +++ b/.github/ISSUE_TEMPLATE/4-release_checklist.md @@ -41,7 +41,9 @@ assignees: '' - [ ] Set the tag version and release title to vX.Y.Z - [ ] Make sure "Set as the latests release" and "Create a discussion for this release" are selected - [ ] Make a release by clicking the 'Publish Release' button, this will automatically create a tag too -- [ ] Manually upload the pygmt-vX.Y.Z.zip and baseline-images.zip files to https://zenodo.org/deposit, ensure that it is filed under the correct reserved DOI +- [ ] Download the pygmt-X.Y.Z.zip and baseline-images.zip from the release page, + rename pygmt-X.Y.Z.zip to pygmt-vX.Y.Z.zip, and upload the two zip files to + https://zenodo.org/deposit, ensure that they are filed under the correct reserved DOI **After release**: From fed3fc98824e92d0781c3484e534b709330af80b Mon Sep 17 00:00:00 2001 From: Dongdong Tian Date: Fri, 6 Sep 2024 12:19:28 +0800 Subject: [PATCH 19/21] Apply suggestions from code review Co-authored-by: Wei Ji <23487320+weiji14@users.noreply.github.com> --- .github/ISSUE_TEMPLATE/4-release_checklist.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/4-release_checklist.md b/.github/ISSUE_TEMPLATE/4-release_checklist.md index beed0a8fb17..84727a5fcf9 100644 --- a/.github/ISSUE_TEMPLATE/4-release_checklist.md +++ b/.github/ISSUE_TEMPLATE/4-release_checklist.md @@ -41,14 +41,14 @@ assignees: '' - [ ] Set the tag version and release title to vX.Y.Z - [ ] Make sure "Set as the latests release" and "Create a discussion for this release" are selected - [ ] Make a release by clicking the 'Publish Release' button, this will automatically create a tag too -- [ ] Download the pygmt-X.Y.Z.zip and baseline-images.zip from the release page, - rename pygmt-X.Y.Z.zip to pygmt-vX.Y.Z.zip, and upload the two zip files to - https://zenodo.org/deposit, ensure that they are filed under the correct reserved DOI +- [ ] Download pygmt-X.Y.Z.zip (rename to pygmt-vX.Y.Z.zip) and baseline-images.zip from + the release page, and upload the two zip files to https://zenodo.org/deposit, + ensure that they are filed under the correct reserved DOI **After release**: - [ ] Update conda-forge [pygmt-feedstock](https://github.com/conda-forge/pygmt-feedstock) - [Done automatically by conda-forge's bot, but can also be triggered manually by opening an issue with the title `@conda-forge-admin, please update version`. Remember to pin SPEC0 versions] + [Done automatically by conda-forge's bot. Remember to pin Python and SPEC0 versions] - [ ] Bump PyGMT version on https://github.com/GenericMappingTools/try-gmt (after conda-forge update) - [ ] Announce the release on: - [ ] GMT [forum](https://forum.generic-mapping-tools.org/c/news/) (do this announcement first! Requires moderator status) From 0708027cfb79507135520205de42862238b0a090 Mon Sep 17 00:00:00 2001 From: Dongdong Tian Date: Fri, 6 Sep 2024 13:39:23 +0800 Subject: [PATCH 20/21] Do not create a discussion for a release --- .github/ISSUE_TEMPLATE/4-release_checklist.md | 1 - 1 file changed, 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/4-release_checklist.md b/.github/ISSUE_TEMPLATE/4-release_checklist.md index 84727a5fcf9..acd9db588b1 100644 --- a/.github/ISSUE_TEMPLATE/4-release_checklist.md +++ b/.github/ISSUE_TEMPLATE/4-release_checklist.md @@ -39,7 +39,6 @@ assignees: '' - [ ] At the [PyGMT release page on GitHub](https://github.com/GenericMappingTools/pygmt/releases): - [ ] Edit the draft release notes with the finalized changelog - [ ] Set the tag version and release title to vX.Y.Z - - [ ] Make sure "Set as the latests release" and "Create a discussion for this release" are selected - [ ] Make a release by clicking the 'Publish Release' button, this will automatically create a tag too - [ ] Download pygmt-X.Y.Z.zip (rename to pygmt-vX.Y.Z.zip) and baseline-images.zip from the release page, and upload the two zip files to https://zenodo.org/deposit, From 0274d4d891eb7317c4d7e33bac63b332720b300a Mon Sep 17 00:00:00 2001 From: Dongdong Tian Date: Tue, 10 Sep 2024 08:08:32 +0800 Subject: [PATCH 21/21] Year 20XX --- .github/ISSUE_TEMPLATE/4-release_checklist.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/4-release_checklist.md b/.github/ISSUE_TEMPLATE/4-release_checklist.md index acd9db588b1..379af1a6b72 100644 --- a/.github/ISSUE_TEMPLATE/4-release_checklist.md +++ b/.github/ISSUE_TEMPLATE/4-release_checklist.md @@ -8,8 +8,8 @@ assignees: '' --- **Release**: [v0.x.x](https://github.com/GenericMappingTools/pygmt/milestones/?) -**Scheduled Date**: YYYY/MM/DD -**Pull request due date**: YYYY/MM/DD +**Scheduled Date**: 20YY/MM/DD +**Pull request due date**: 20YY/MM/DD **DOI**: `10.5281/zenodo.XXXXXXX` **Priority PRs/issues to complete prior to release**