DOC: Improve release checklist #4348
Merged
+2
−1
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
yvonnefroehlich
added
documentation
seisman
reviewed
Jan 13, 2026
| - [ ] 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) | ||
| - [ ] 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 for broken links (e.g., [External Resources](https://www.pygmt.org/dev/external_resources.html)) |
Member
There was a problem hiding this comment.
Actually, we missed the broken links because the "Check Links" workflow failed recently (https://github.com/GenericMappingTools/pygmt/actions/runs/20895342763). Related to lycheeverse/lychee#1934
Member
There was a problem hiding this comment.
Could you please move this item to line ~30, and change it to something like:
- [ ] Check for broken links in the [Check Links](https://github.com/GenericMappingTools/pygmt/actions/workflows/check-links.yml)
seisman
reviewed
Jan 14, 2026
| - [ ] 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) | ||
| - [ ] Check for broken links in the [Check Links](https://github.com/GenericMappingTools/pygmt/actions/workflows/check-links.yml) |
Member
There was a problem hiding this comment.
Suggested change
| - [ ] Check for broken links in the [Check Links](https://github.com/GenericMappingTools/pygmt/actions/workflows/check-links.yml) | |
| - [ ] Check for broken links in the ["Check Links" workflow](https://github.com/GenericMappingTools/pygmt/actions/workflows/check-links.yml) |
seisman
approved these changes
Jan 14, 2026
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description of proposed changes
Two small improvements of the release checklist.
Guidelines
Slash Commands
You can write slash commands (
/command) in the first line of a comment to performspecific operations. Supported slash command is:
/format: automatically format and lint the code