-
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
Merged
Merged
Changes from 7 commits
Commits
Show all changes
25 commits
Select commit
Hold shift + click to select a range
c09cd24
Move spelling check to the end of the list
seisman 30c081f
Fix a typo
seisman ad5fffd
GMT-GS compatability is not in a new separate subsection
seisman 13961dc
Remove deprecated codes first before checking other CI workflows
seisman ea7c25d
Add a entry to check pre-commit hooks
seisman 4470f96
Draft the announcement before the release
seisman 7316504
Typo
seisman bbda6c2
Update .github/ISSUE_TEMPLATE/4-release_checklist.md
seisman fcfe59d
Review the PyGMT team page earlier since it may take some time
seisman a403117
Merge branch 'main' into release-checklist
seisman aff71d2
No need to check hooks manually after enabling pre-commit.ci
seisman f506f65
Merge branch 'main' into release-checklist
seisman 12a2011
Show DOI at the top
seisman 55f27eb
Simplify the checklist for changelog entry
seisman fcfd34a
Update the command to check deprecations in this version
seisman a4af06e
Create a discussion for this release
seisman be22c85
Merge branch 'main' into release-checklist
seisman a996ec9
Check spelling before drafting annoucement
seisman a6e3e98
Add instructions to trigger conda-forge's update manually
seisman d809f74
Fix a typo
seisman 2d979e2
Need to rename the zip file before uploading
seisman fed3fc9
Apply suggestions from code review
seisman 0708027
Do not create a discussion for a release
seisman a26795c
Merge branch 'main' into release-checklist
seisman 0274d4d
Year 20XX
seisman File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -17,14 +17,15 @@ 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 | ||
- [ ] 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: | ||
seisman marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
@@ -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) | ||
--- | ||
|
||
|
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.
Uh oh!
There was an error while loading. Please reload this page.