Skip to content
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

Update the release checklist post v0.14.0 release #3692

Merged
merged 9 commits into from
Jan 6, 2025

Conversation

seisman
Copy link
Member

@seisman seisman commented Dec 16, 2024

Description of proposed changes

@seisman seisman added this to the 0.15.0 milestone Dec 16, 2024
@seisman seisman added the maintenance Boring but important stuff for the core devs label Dec 16, 2024
@seisman seisman removed this from the 0.15.0 milestone Dec 31, 2024
Co-authored-by: Wei Ji <[email protected]>
@seisman
Copy link
Member Author

seisman commented Jan 3, 2025

Currently, the "Changelog entry for vX.Y.Z" PRs (e.g., #3730 and previous ones) modifies five files:

  • CITATION.cff: update citation information
  • README.md: update citation information
  • doc/_static/version_switch.js: add to version switcher
  • doc/minversions.md: add information of min version
  • doc/changes.md: add the changelog

I feel we should split this PR into 3 or 4 smaller PRs, so that discussions about author orders won't be buried in lots of comments/changes to the changelog.

The 3 PRs can be:

  1. doc/_static/version_switch.js + doc/minversions.md: Add vX.Y.Z to the doc version switcher and "minimum supported version" table
  2. CITATION.cff + README.md: Update citation information for vX.Y.Z
  3. doc/changes.md: Changelog entry for vX.Y.Z

Since the release dates in CITATION.cff/README.md/doc/changes.md may change if we decide to postpone a release, PR 2 should be merged only when PR 3 is ready.

What do @GenericMappingTools/pygmt-maintainers think about the changes? If agreed, I will update the release checklist.

@seisman seisman added this to the 0.15.0 milestone Jan 3, 2025
@weiji14
Copy link
Member

weiji14 commented Jan 3, 2025

The 3 PRs can be:

1. `doc/_static/version_switch.js` + `doc/minversions.md`: Add vX.Y.Z to the doc version switcher and "minimum supported version" table

2. `CITATION.cff` + `README.md`: Update citation information for vX.Y.Z

3. `doc/changes.md`: Changelog entry for vX.Y.Z

Since the release dates in CITATION.cff/README.md/doc/changes.md may change if we decide to postpone a release, PR 2 should be merged only when PR 3 is ready.

I'd prefer to keep things in a single PR so that the tagged commit has both the changelog and authorship changes. Or we could do just two PRs (1, and 2+3, so that the date changes are in sync). But no strong opinions.

@seisman seisman added the needs review This PR has higher priority and needs review. label Jan 3, 2025
@seisman seisman changed the title WIP: Update the release checklist based on the v0.14.0 release process Update the release checklist based on the v0.14.0 release process Jan 4, 2025
@seisman
Copy link
Member Author

seisman commented Jan 4, 2025

keep things in a single PR so that the tagged commit has both the changelog and authorship changes.

That's a fair point. Let's keep things in a single PR.

Will merge #3741 into this PR, then this PR should be good for final review.

@seisman seisman marked this pull request as ready for review January 6, 2025 11:10
@seisman seisman changed the title Update the release checklist based on the v0.14.0 release process Update the release checklist post v0.14.0 release Jan 6, 2025
@seisman seisman added final review call This PR requires final review and approval from a second reviewer skip-changelog Skip adding Pull Request to changelog and removed needs review This PR has higher priority and needs review. labels Jan 6, 2025
@seisman seisman merged commit 4c03bab into main Jan 6, 2025
9 checks passed
@seisman seisman deleted the maintenance/release-checklist branch January 6, 2025 14:57
@seisman seisman removed the final review call This PR requires final review and approval from a second reviewer label Jan 6, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
maintenance Boring but important stuff for the core devs skip-changelog Skip adding Pull Request to changelog
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants