-
Notifications
You must be signed in to change notification settings - Fork 229
Improve the release checklist based on experience with v0.13.0 release #3374
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from 9 commits
c09cd24
30c081f
ad5fffd
13961dc
ea7c25d
4470f96
7316504
bbda6c2
fcfe59d
a403117
aff71d2
f506f65
12a2011
55f27eb
fcfd34a
a4af06e
be22c85
a996ec9
a6e3e98
d809f74
2d979e2
fed3fc9
0708027
a26795c
0274d4d
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -17,17 +17,18 @@ 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 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) | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Review the PyGMT team as early as possible so that we have more time for discussions. |
||
- [ ] 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()` 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: | ||
- [ ] 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 | ||
|
@@ -37,6 +38,8 @@ 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 | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Start to draft the announcement when we work on the changelog, so that we can finish the announcement as early as possible after making a release. |
||
- [ ] 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): | ||
|
@@ -49,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) | ||
--- | ||
|
||
|
Uh oh!
There was an error while loading. Please reload this page.