Skip to content

Commit 2bb65df

Browse files
seismanmichaelgrundyvonnefroehlichweiji14
authored
Improve the release checklist based on experience with v0.13.0 release (#3374)
Co-authored-by: Michael Grund <23025878+michaelgrund@users.noreply.github.com> Co-authored-by: Yvonne Fröhlich <94163266+yvonnefroehlich@users.noreply.github.com> Co-authored-by: Wei Ji <23487320+weiji14@users.noreply.github.com>
1 parent bed8fa5 commit 2bb65df

File tree

1 file changed

+22
-20
lines changed

1 file changed

+22
-20
lines changed

.github/ISSUE_TEMPLATE/4-release_checklist.md

Lines changed: 22 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -8,49 +8,51 @@ assignees: ''
88
---
99

1010
**Release**: [v0.x.x](https://github.com/GenericMappingTools/pygmt/milestones/?)
11-
**Scheduled Date**: YYYY/MM/DD
12-
**Pull request due date**: YYYY/MM/DD
11+
**Scheduled Date**: 20YY/MM/DD
12+
**Pull request due date**: 20YY/MM/DD
13+
**DOI**: `10.5281/zenodo.XXXXXXX`
1314

1415
**Priority PRs/issues to complete prior to release**
16+
1517
- [ ] Wrap X ()
1618
- [ ] Wrap Y ()
1719

1820
**Before release**:
21+
1922
- [ ] 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)
20-
- [ ] Run `make codespell` to check common misspellings. If there are any, either fix them or add them to `ignore-words-list` in `pyproject.toml`
23+
- [ ] Review the ["PyGMT Team" page](https://www.pygmt.org/dev/team.html)
2124
- [ ] Check to ensure that:
25+
- [ ] Deprecations and related tests are removed for this version by running `grep --include="*.py" -r vX.Y.Z` from the base of the repository
2226
- [ ] All tests pass in the ["GMT Legacy Tests" workflow](https://github.com/GenericMappingTools/pygmt/actions/workflows/ci_tests_legacy.yaml)
2327
- [ ] All tests pass in the ["GMT Dev Tests" workflow](https://github.com/GenericMappingTools/pygmt/actions/workflows/ci_tests_dev.yaml)
2428
- [ ] All tests pass in the ["Doctests" workflow](https://github.com/GenericMappingTools/pygmt/actions/workflows/ci_doctests.yaml)
25-
- [ ] 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
26-
- [ ] Update warnings in `pygmt.show_versions()` as well as notes in [Common installation issues](https://www.pygmt.org/dev/install.html#not-working-transparency)
27-
and [Testing your install]((https://www.pygmt.org/dev/install.html#testing-your-install) regarding GMT-Ghostscript incompatibility
29+
- [ ] Update warnings in `pygmt/_show_versions.py` as well as notes in
30+
[Not working transparency](https://www.pygmt.org/dev/install.html#not-working-transparency)
31+
regarding GMT-Ghostscript incompatibility
2832
- [ ] Reserve a DOI on [Zenodo](https://zenodo.org) by clicking on "New Version"
29-
- [ ] Review the ["PyGMT Team" page](https://www.pygmt.org/dev/team.html)
30-
- [ ] Finish up 'Changelog entry for v0.x.x' Pull Request:
31-
- [ ] Add a new entry in `doc/_static/version_switch.js` for documentation switcher
32-
- [ ] Update `CITATION.cff` and BibTeX at https://github.com/GenericMappingTools/pygmt#citing-pygmt
33-
- [ ] Update authorship list
34-
- [ ] Update DOI (and url for BibTeX)
35-
- [ ] Update version
36-
- [ ] Update date released
37-
- [ ] Add the documentation link `doc/minversions.md`
38-
- [ ] Add minimum required version information `doc/minversions.md`
39-
- [ ] 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))
33+
- [ ] Finish up the "Changelog entry for v0.x.x" Pull Request (Use the previous changelog PR as a reference)
34+
- [ ] Run `make codespell` to check common misspellings. If there are any, either fix them or add them to `ignore-words-list` in `pyproject.toml`
35+
- [ ] Draft the announcement on https://hackmd.io/@pygmt
4036

4137
**Release**:
38+
4239
- [ ] At the [PyGMT release page on GitHub](https://github.com/GenericMappingTools/pygmt/releases):
4340
- [ ] Edit the draft release notes with the finalized changelog
4441
- [ ] Set the tag version and release title to vX.Y.Z
4542
- [ ] Make a release by clicking the 'Publish Release' button, this will automatically create a tag too
46-
- [ ] 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
43+
- [ ] Download pygmt-X.Y.Z.zip (rename to pygmt-vX.Y.Z.zip) and baseline-images.zip from
44+
the release page, and upload the two zip files to https://zenodo.org/deposit,
45+
ensure that they are filed under the correct reserved DOI
4746

4847
**After release**:
49-
- [ ] 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]
48+
49+
- [ ] Update conda-forge [pygmt-feedstock](https://github.com/conda-forge/pygmt-feedstock)
50+
[Done automatically by conda-forge's bot. Remember to pin Python and SPEC0 versions]
5051
- [ ] Bump PyGMT version on https://github.com/GenericMappingTools/try-gmt (after conda-forge update)
5152
- [ ] Announce the release on:
52-
- [ ] GMT [forum](https://forum.generic-mapping-tools.org/c/news/) (do this announcement first! draft on https://hackmd.io/@pygmt. requires moderator status)
53+
- [ ] GMT [forum](https://forum.generic-mapping-tools.org/c/news/) (do this announcement first! Requires moderator status)
5354
- [ ] [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)
55+
5456
---
5557

5658
- [ ] Party :tada: (don't tick before all other checkboxes are ticked!)

0 commit comments

Comments
 (0)