Skip to content

Changelog entry for v0.13.0#3425

Merged
seisman merged 18 commits intomainfrom
changelog/v0.13.0
Sep 5, 2024
Merged

Changelog entry for v0.13.0#3425
seisman merged 18 commits intomainfrom
changelog/v0.13.0

Conversation

@seisman
Copy link
Member

@seisman seisman commented Sep 4, 2024 •
edited
Loading

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
@seisman seisman mentioned this pull request Sep 4, 2024
Closed
39 tasks
yvonnefroehlich
yvonnefroehlich reviewed Sep 4, 2024
View reviewed changes
seisman
seisman commented Sep 4, 2024
View reviewed changes
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

@seisman seisman Sep 4, 2024

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

@yvonnefroehlich yvonnefroehlich Sep 4, 2024

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

pygmt/.github/release-drafter.yml

Lines 8 to 20 in 6dc8eb0

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 •
edited
Loading

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

@seisman seisman Sep 4, 2024

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.

seisman
seisman commented Sep 4, 2024
View reviewed changes
@seisman seisman marked this pull request as ready for review September 4, 2024 15:03
yvonnefroehlich
yvonnefroehlich reviewed Sep 4, 2024
View reviewed changes
weiji14
weiji14 reviewed Sep 4, 2024
View reviewed changes
CITATION.cff
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

@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.

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 •
edited
Loading

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.

seisman and others added 2 commits September 5, 2024 06:38
@seisman @yvonnefroehlich
Apply suggestions from code review
c7bfbbd 
Co-authored-by: Yvonne Fröhlich <94163266+yvonnefroehlich@users.noreply.github.com>
@seisman
Update doc/changes.md
7d3ac63
seisman
seisman commented Sep 5, 2024
View reviewed changes
@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).

weiji14
weiji14 reviewed Sep 5, 2024
View reviewed changes
doc/changes.md Outdated
Comment on lines 60 to 61
* SPEC 0: Bump minimum supported version to xarray 2022.09 ([#3372](https://github.com/GenericMappingTools/pygmt/pull/3372))
* SPEC 0: Bump minimum supported version to NumPy 1.24+ ([#3286](https://github.com/GenericMappingTools/pygmt/pull/3286))
Copy link
Member

@weiji14 weiji14 Sep 5, 2024

Choose a reason for hiding this comment

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

These should go under 'Deprecations' I think. We used to classify the NEP29 PRs as 'deprecations' (e.g. at https://www.pygmt.org/v0.12.0/changes.html#release-v0-11-0-2024-02-01), but somehow put the SPEC 0 PRs under 'maintenance' in Release v0.12.0. Probably should move them all to Deprecations.

seisman and others added 2 commits September 5, 2024 12:58
@seisman @weiji14
Apply suggestions from code review
a15a6cf 
Co-authored-by: Wei Ji <23487320+weiji14@users.noreply.github.com>
@seisman
Move some entries to different sections
60f3f0b
seisman
seisman commented Sep 5, 2024
View reviewed changes
weiji14
weiji14 approved these changes Sep 5, 2024
View reviewed changes
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.

michaelgrund
michaelgrund approved these changes Sep 5, 2024
View reviewed changes
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!

@seisman @michaelgrund
Polish the changelog entries
fec04a7 
Co-authored-by: Michael Grund <23025878+michaelgrund@users.noreply.github.com>
yvonnefroehlich
yvonnefroehlich reviewed Sep 5, 2024
View reviewed changes
yvonnefroehlich
yvonnefroehlich reviewed Sep 5, 2024
View reviewed changes
yvonnefroehlich
yvonnefroehlich reviewed Sep 5, 2024
View reviewed changes
yvonnefroehlich
yvonnefroehlich approved these changes Sep 5, 2024
View reviewed changes
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!

@seisman @yvonnefroehlich
Apply suggestions from code review
6531d60 
Co-authored-by: Yvonne Fröhlich <94163266+yvonnefroehlich@users.noreply.github.com>
michaelgrund
michaelgrund approved these changes Sep 5, 2024
View reviewed changes
@seisman @michaelgrund
Fix a typo
ec9c2da 
Co-authored-by: Michael Grund <23025878+michaelgrund@users.noreply.github.com>
@seisman seisman merged commit 1ff03a3 into main Sep 5, 2024
@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
@seisman seisman mentioned this pull request Sep 5, 2024
Merged
@weiji14 weiji14 mentioned this pull request Dec 19, 2024
Merged
4 tasks
@seisman seisman mentioned this pull request Dec 28, 2024
Merged
16 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@yvonnefroehlich yvonnefroehlich yvonnefroehlich approved these changes

@michaelgrund michaelgrund michaelgrund approved these changes

@weiji14 weiji14 weiji14 approved these changes

Assignees

No one assigned

Labels

maintenance Boring but important stuff for the core devs skip-changelog Skip adding Pull Request to changelog

Projects

None yet

Milestone

0.13.0

Development

Successfully merging this pull request may close these issues.

4 participants

@seisman @michaelgrund @weiji14 @yvonnefroehlich