Skip to content

Changelog entry for v0.18.0 #4323

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.

Sign up for GitHub

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

Jump to bottom
Draft
seisman wants to merge 22 commits into
base: main
Choose a base branch
from
Draft

Changelog entry for v0.18.0 #4323

seisman wants to merge 22 commits into from
+98 −9

Conversation

@seisman
Copy link
Member

@seisman seisman commented Dec 29, 2025 •
edited
Loading

Description of proposed changes

This PR adds the changelog entry for v0.18.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 (check if there are new contributors!)
    • Update CITATION.cff
      • Update DOI
      • Update date released
      • Update version
    • Update BibTeX in README
      • Update the BibTeX key
      • Update date released
      • Update version
      • Update DOI and URL
  • 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)
    • Add the separator --- between the old and new changelog sections
    • 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. Use the following command: 
      git shortlog v0.17.0..HEAD -sne --group=author --group=trailer:co-authored-by
    • 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 Dec 29, 2025
@seisman seisman added this to the 0.18.0 milestone Dec 29, 2025
@seisman seisman mentioned this pull request Dec 29, 2025
Open
30 tasks
yvonnefroehlich
yvonnefroehlich reviewed Jan 6, 2026
View reviewed changes
yvonnefroehlich
yvonnefroehlich reviewed Jan 6, 2026
View reviewed changes
yvonnefroehlich
yvonnefroehlich reviewed Jan 6, 2026
View reviewed changes
yvonnefroehlich
yvonnefroehlich reviewed Jan 6, 2026
View reviewed changes
yvonnefroehlich
yvonnefroehlich reviewed Jan 6, 2026
View reviewed changes
doc/changes.md Outdated
* pygmt.select: Deprecate parameter gridmask to mask_grid (Will be removed in v0.20.0) ([#4283](https://github.com/GenericMappingTools/pygmt/pull/4283))
* pygmt.grdsample: Deprecate parameter 'translate' to 'toggle' (remove in v0.21.0) ([#4187](https://github.com/GenericMappingTools/pygmt/pull/4187))
* pygmt.grdlandmask: Deprecate parameters bordervalues/maskvalues to broder_values/mask_values (Will be removed in v0.20.0) ([#4281](https://github.com/GenericMappingTools/pygmt/pull/4281))
* pygmt.grdfill: Deprecate parameters splinefill/constantfill/neighborfill/gridfill to spline_fill/constant_fill/neighbor_fill/grid_fill (Will be removed in v0.20.0) ([#4273](https://github.com/GenericMappingTools/pygmt/pull/4273))
Copy link
Member

@yvonnefroehlich yvonnefroehlich Jan 6, 2026 •
edited
Loading

Choose a reason for hiding this comment

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

We also have the deprecation of parameter mode to the parameters constantfill/gridfill/neighborfill/splinefill instead (since v0.15.0; removed in v0.19.0).

seisman and others added 9 commits January 7, 2026 12:45
@seisman @yvonnefroehlich
Sort deprecation changes alphabetically
6d35e41 
Co-authored-by: Yvonne Fröhlich <94163266+yvonnefroehlich@users.noreply.github.com>
@seisman @yvonnefroehlich
Sort entries alphabetically [skip ci]
1b8ffff 
Co-authored-by: Yvonne Fröhlich <94163266+yvonnefroehlich@users.noreply.github.com>
@seisman @yvonnefroehlich
Use * instead of - for contributor list [skip ci]
79e3b75 
Co-authored-by: Yvonne Fröhlich <94163266+yvonnefroehlich@users.noreply.github.com>
@seisman @yvonnefroehlich
Remove one extra whitespace [skip ci]
686dd00 
Co-authored-by: Yvonne Fröhlich <94163266+yvonnefroehlich@users.noreply.github.com>
@seisman @yvonnefroehlich
Update doc/changes.md
f6bf733 
Co-authored-by: Yvonne Fröhlich <94163266+yvonnefroehlich@users.noreply.github.com>
@seisman @yvonnefroehlich
Add hightlights
756711e 
Co-authored-by: Yvonne Fröhlich <94163266+yvonnefroehlich@users.noreply.github.com>
@seisman
Merge branch 'main' into changelog/v0.18.0
8662471
@seisman
Merge branch 'main' into changelog/v0.18.0
d484e4c
@seisman
Add one more highlight
ceb2b15
seisman
seisman commented Jan 7, 2026
View reviewed changes
seisman
seisman commented Jan 7, 2026
View reviewed changes
CITATION.cff
orcid: https://orcid.org/0000-0001-5708-7336
date-released: 2025-10-03
doi: 10.5281/zenodo.17156962
date-released: 2026-01-06
Copy link
Member Author

@seisman seisman Jan 7, 2026

Choose a reason for hiding this comment

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

Need to update the release date.

doc/changes.md
@@ -1,5 +1,94 @@
# Changelog

## Release v0.18.0 (2026/01/06)
Copy link
Member Author

@seisman seisman Jan 7, 2026

Choose a reason for hiding this comment

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

Need to update the release date.

michaelgrund
michaelgrund reviewed Jan 7, 2026
View reviewed changes
@seisman @michaelgrund
Improve changelog entries
9d9979e 
Co-authored-by: Michael Grund <23025878+michaelgrund@users.noreply.github.com>
@seisman seisman added the needs review This PR has higher priority and needs review. label Jan 7, 2026
yvonnefroehlich
yvonnefroehlich reviewed Jan 7, 2026
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.

In PR #4193 Xingchen He was added to the AUTHORS.md file, but he was not added to the CITATION.cff file yet.

yvonnefroehlich
yvonnefroehlich reviewed Jan 7, 2026
View reviewed changes
seisman and others added 2 commits January 8, 2026 09:31
@seisman @yvonnefroehlich
Update doc/changes.md
90d7903 
Co-authored-by: Yvonne Fröhlich <94163266+yvonnefroehlich@users.noreply.github.com>
@seisman
Improve highlight
949fa69
@seisman
Copy link
Member Author

seisman commented Jan 8, 2026

In PR #4193 Xingchen He was added to the AUTHORS.md file, but he was not added to the CITATION.cff file yet.

Following our authorship policy, we will add @Chuan1937 as an author of the Zenodo archive unless @Chuan1937 says no.

@weiji14
Copy link
Member

weiji14 commented Jan 8, 2026

In PR #4193 Xingchen He was added to the AUTHORS.md file, but he was not added to the CITATION.cff file yet.

Following our authorship policy, we will add @Chuan1937 as an author of the Zenodo archive unless @Chuan1937 says no.

From reading https://github.com/GenericMappingTools/pygmt/blob/v0.17.0/AUTHORSHIP.md#authorship-on-zenodo-archives-of-releases, it sounds like if we add someone to Zenodo, they should be on the CITATION.cff too?

@seisman
Copy link
Member Author

seisman commented Jan 8, 2026

In PR #4193 Xingchen He was added to the AUTHORS.md file, but he was not added to the CITATION.cff file yet.

Following our authorship policy, we will add @Chuan1937 as an author of the Zenodo archive unless @Chuan1937 says no.

From reading https://github.com/GenericMappingTools/pygmt/blob/v0.17.0/AUTHORSHIP.md#authorship-on-zenodo-archives-of-releases, it sounds like if we add someone to Zenodo, they should be on the CITATION.cff too?

Yes.

yvonnefroehlich
yvonnefroehlich reviewed Jan 8, 2026
View reviewed changes
@seisman @yvonnefroehlich
Sort entries
17c1704 
Co-authored-by: Yvonne Fröhlich <94163266+yvonnefroehlich@users.noreply.github.com>
yvonnefroehlich
yvonnefroehlich reviewed Jan 8, 2026
View reviewed changes
seisman and others added 2 commits January 8, 2026 23:29
@seisman @yvonnefroehlich
Update doc/changes.md
a54414a 
Co-authored-by: Yvonne Fröhlich <94163266+yvonnefroehlich@users.noreply.github.com>
@seisman
Add Xingchen He to CITATION.cff
4429b61
@seisman
Copy link
Member Author

seisman commented Jan 9, 2026

In PR #4193 Xingchen He was added to the AUTHORS.md file, but he was not added to the CITATION.cff file yet.

I've added @Chuan1937 to CITATION.cff in 4429b61. Need to remember to update the author list when releasing on Zenodo.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@michaelgrund michaelgrund michaelgrund left review comments

@yvonnefroehlich yvonnefroehlich yvonnefroehlich left review comments

At least 1 approving review is required to merge this pull request.

Assignees

No one assigned

Labels

maintenance Boring but important stuff for the core devs needs review This PR has higher priority and needs review. skip-changelog Skip adding Pull Request to changelog

Projects

None yet

Milestone

0.18.0

Development

Successfully merging this pull request may close these issues.

5 participants

@seisman @weiji14 @michaelgrund @yvonnefroehlich