Skip to content

Commit 26d72c8

Browse files
Meghan Jonesweiji14
Meghan Jones
andauthored
Strengthen the release checklist and maintenance instructions (#1822)
* Strengthen the release checklist and maintenance instructions * Add note about NEP29 in conda-forge feedstock Co-authored-by: Wei Ji <[email protected]>
1 parent 1b6b040 commit 26d72c8

File tree

2 files changed

+9
-5
lines changed

2 files changed

+9
-5
lines changed

.github/ISSUE_TEMPLATE/release_checklist.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,12 @@ assignees: ''
2121
- [ ] Finish up 'Changelog entry for v0.x.x' Pull Request:
2222
- [ ] Add a new entry in `doc/_static/version_switch.js` for documentation switcher
2323
- [ ] Update `CITATION.cff` and BibTeX at https://github.com/GenericMappingTools/pygmt#citing-pygmt
24-
- [ ] Add the documentation link https://github.com/GenericMappingTools/pygmt#documentation-for-other-versions
25-
- [ ] Add compatibility information https://github.com/GenericMappingTools/pygmt#compatibility-with-gmt-and-pythonnumpy-versions
24+
- [ ] Update authorship list
25+
- [ ] Update DOI (and url for BibTeX)
26+
- [ ] Update version
27+
- [ ] Update date released
28+
- [ ] Add the documentation link https://github.com/GenericMappingTools/pygmt#compatibility-with-gmtpythonnumpy-versions
29+
- [ ] Add compatibility information https://github.com/GenericMappingTools/pygmt#compatibility-with-gmtpythonnumpy-versions
2630
- [ ] 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))
2731

2832
**Release**:
@@ -33,11 +37,10 @@ assignees: ''
3337
- [ ] 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
3438

3539
**After release**:
36-
- [ ] Update conda-forge [pygmt-feedstock](https://github.com/conda-forge/pygmt-feedstock) [Usually done automatically by conda-forge's bot]
40+
- [ ] Update conda-forge [pygmt-feedstock](https://github.com/conda-forge/pygmt-feedstock) [Done automatically by conda-forge's bot, but remember to pin NEP29 versions]
3741
- [ ] Bump PyGMT version on https://github.com/GenericMappingTools/try-gmt (after conda-forge update)
3842
- [ ] Announce the release on:
3943
- [ ] GMT [forum](https://forum.generic-mapping-tools.org/c/news/) (do this announcement first! draft on https://hackmd.io/@pygmt. requires moderator status)
40-
- [ ] [Major/Minor releases only] GMT [website](https://github.com/GenericMappingTools/website) (News)
4144
- [ ] [ResearchGate](https://www.researchgate.net/project/PyGMT-A-Python-interface-for-the-Generic-Mapping-Tools) (after forum announcement)
4245
- [ ] [Twitter](https://twitter.com/gmt_dev) (after forum announcement)
4346
---

doc/maintenance.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -266,7 +266,8 @@ publishing the actual release notes at https://www.pygmt.org/latest/changes.html
266266
[NEP 29](https://numpy.org/neps/nep-0029-deprecation_policy.html#detailed-description)
267267
for compatibility updates.
268268
9. Refresh citation information. Specifically, the BibTeX in `README.rst` and
269-
`CITATION.cff` needs to be updated with any metadata changes. Please follow
269+
`CITATION.cff` needs to be updated with any metadata changes, including the
270+
DOI, release date, and version information. Please also follow
270271
guidelines in `AUTHORSHIP.md` for updating the author list in the BibTeX.
271272
More information about the `CITATION.cff` specification can be found at
272273
https://github.com/citation-file-format/citation-file-format/blob/main/schema-guide.md

0 commit comments

Comments
 (0)