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

Changelog entry for v0.13.0 #3425

Merged
merged 18 commits into from
Sep 5, 2024
Merged

Changelog entry for v0.13.0 #3425

merged 18 commits into from
Sep 5, 2024

Conversation

seisman
Copy link
Member

@seisman seisman commented Sep 4, 2024

Description of proposed changes

This PR adds the changelog entry for v0.13.0.

Checklist

  • Add a new entry in doc/_static/version_switch.js for documentation switcher
  • Add the version to the compatibility table doc/minversions.md
  • Update citation information CITATION.cff and BibTeX at https://github.com/GenericMappingTools/pygmt#citing-pygmt
    • Update authorship list if necessary
    • Update DOI (and URL for BibTeX)
    • Update version
    • Update date released
    • Update the BibTeX key
  • Copy the draft release note from https://github.com/GenericMappingTools/pygmt/releases to doc/changes.md
  • Edit the changelog to look nice (see maintainers guide for details)
    • Update the release date and the DOI badge in doc/changes.md
    • Edit the list of people who contributed to the release, linking to their GitHub account. Sort their names by the number of commits made since the last release (e.g., use git shortlog HEAD...v0.1.2 -sne)
    • Edit the change list to remove any trivial changes (updates to the README, typo fixes, CI configuration, etc)
    • Update with any remaining PRs merged before release
    • Add highlights

@seisman seisman added maintenance Boring but important stuff for the core devs skip-changelog Skip adding Pull Request to changelog labels Sep 4, 2024
@seisman seisman added this to the 0.13.0 milestone Sep 4, 2024
doc/changes.md Outdated Show resolved Hide resolved
doc/changes.md Outdated

### Enhancements

* pygmt.x2sys_cross: Refactor to use virtualfiles for output tables [BREAKING CHANGE: Dummy times in 3rd and 4th columns now have np.timedelta64 type] ([#3182](https://github.com/GenericMappingTools/pygmt/pull/3182))
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perhaps we should add a separate category for breaking changes?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would make those changes more / directly visible to users!

Meaning we have to define a new label "breaking changes" and add it to

categories:
- title: 'New Features'
label: 'feature'
- title: 'Enhancements'
label: 'enhancement'
- title: 'Deprecations'
label: 'deprecation'
- title: 'Bug Fixes'
label: 'bug'
- title: 'Documentation'
label: 'documentation'
- title: 'Maintenance'
label: 'maintenance'

Copy link
Member

@weiji14 weiji14 Sep 4, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Common changelog uses a prefix like **Breaking** or **<subsystem> (breaking):** for highlighting breaking changes, see https://github.com/vweevers/common-changelog?tab=readme-ov-file#244-prefixes. Maybe we could follow that instead of adding a new label/section?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sounds good. Changes in 7d3ac63.

doc/changes.md Outdated Show resolved Hide resolved
doc/changes.md Outdated Show resolved Hide resolved
doc/changes.md Outdated Show resolved Hide resolved
doc/changes.md Outdated Show resolved Hide resolved
doc/changes.md Outdated Show resolved Hide resolved
doc/changes.md Outdated Show resolved Hide resolved
@seisman seisman marked this pull request as ready for review September 4, 2024 15:03
doc/changes.md Outdated Show resolved Hide resolved
doc/changes.md Outdated Show resolved Hide resolved
doc/changes.md Outdated Show resolved Hide resolved
doc/changes.md Outdated Show resolved Hide resolved
doc/changes.md Outdated Show resolved Hide resolved
Comment on lines 76 to 78
family-names: Wessel
affiliation: University of Hawaiʻi at Mānoa, USA
orcid: https://orcid.org/0000-0001-5708-7336
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Didn't want to bring this up so soon, but since Paul passed away, I'm wondering what the convention was in keeping his name on the citation list? Do we remove his name now, keep his name on for a couple more releases, or remove it after his funding/grants run out? See e.g. https://academia.stackexchange.com/questions/116845/dead-author-ethical-guidelines

Copy link
Member Author

@seisman seisman Sep 5, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Personally, I prefer to keep Paul's name at least in the period of the funding.

The link you provided only discussed the topic for journal articles, but here it's software and may be slightly different.

Anyway, we should keep this in mind and may need to revisit it later.

Edit: Probably should ask for comments from the GMT steering community. Will do it later.

doc/changes.md Outdated Show resolved Hide resolved
@seisman seisman added the final review call This PR requires final review and approval from a second reviewer label Sep 5, 2024
@seisman
Copy link
Member Author

seisman commented Sep 5, 2024

This PR is ready for final review. I plan to merge this PR and make the release in 12 hours (before midnight for UTC+8 time zone).

doc/changes.md Outdated Show resolved Hide resolved
doc/changes.md Outdated Show resolved Hide resolved
doc/changes.md Outdated Show resolved Hide resolved
doc/changes.md Outdated Show resolved Hide resolved
doc/changes.md Outdated Show resolved Hide resolved
doc/changes.md Outdated Show resolved Hide resolved
Copy link
Member

@weiji14 weiji14 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me! Wait for second approval before merge.

Copy link
Member

@michaelgrund michaelgrund left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good!

doc/changes.md Outdated Show resolved Hide resolved
doc/changes.md Outdated Show resolved Hide resolved
Co-authored-by: Michael Grund <[email protected]>
doc/changes.md Outdated Show resolved Hide resolved
doc/changes.md Show resolved Hide resolved
doc/changes.md Outdated Show resolved Hide resolved
doc/changes.md Outdated Show resolved Hide resolved
Copy link
Member

@yvonnefroehlich yvonnefroehlich left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good for me!

Co-authored-by: Yvonne Fröhlich <[email protected]>
doc/changes.md Outdated Show resolved Hide resolved
Co-authored-by: Michael Grund <[email protected]>
@seisman seisman merged commit 1ff03a3 into main Sep 5, 2024
9 of 10 checks passed
@seisman seisman deleted the changelog/v0.13.0 branch September 5, 2024 11:42
@seisman seisman removed the final review call This PR requires final review and approval from a second reviewer label Sep 5, 2024
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.

4 participants