You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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>
**Priority PRs/issues to complete prior to release**
16
+
15
17
-[ ] Wrap X ()
16
18
-[ ] Wrap Y ()
17
19
18
20
**Before release**:
21
+
19
22
-[ ] 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)
21
24
-[ ] 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
22
26
-[ ] All tests pass in the ["GMT Legacy Tests" workflow](https://github.com/GenericMappingTools/pygmt/actions/workflows/ci_tests_legacy.yaml)
23
27
-[ ] All tests pass in the ["GMT Dev Tests" workflow](https://github.com/GenericMappingTools/pygmt/actions/workflows/ci_tests_dev.yaml)
24
28
-[ ] 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
28
32
-[ ] 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
40
36
41
37
**Release**:
38
+
42
39
-[ ] At the [PyGMT release page on GitHub](https://github.com/GenericMappingTools/pygmt/releases):
43
40
-[ ] Edit the draft release notes with the finalized changelog
44
41
-[ ] Set the tag version and release title to vX.Y.Z
45
42
-[ ] 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
47
46
48
47
**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]
[Done automatically by conda-forge's bot. Remember to pin Python and SPEC0 versions]
50
51
-[ ] Bump PyGMT version on https://github.com/GenericMappingTools/try-gmt (after conda-forge update)
51
52
-[ ] 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)
53
54
-[ ][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
+
54
56
---
55
57
56
58
-[ ] Party :tada: (don't tick before all other checkboxes are ticked!)
0 commit comments