Skip to content

Update the issue template for bumping GMT versions #4167

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

Merged
seisman merged 3 commits into from
Oct 16, 2025
Merged

Update the issue template for bumping GMT versions #4167

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7d69831
Update the issue template for bumping GMT versions
seisman Dec 27, 2024
f9dbdab
Fix the grep command
seisman Oct 16, 2025
1d26447
Update .github/ISSUE_TEMPLATE/4-release_checklist.md
seisman Oct 16, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 12 additions & 7 deletions .github/ISSUE_TEMPLATE/5-bump_gmt_checklist.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,10 @@ assignees: ''

---

:tada: [GMT X.Y.Z](https://github.com/GenericMappingTools/gmt/releases/tag/X.Y.Z) has been released!
It is installable from the [conda-forge channel](https://anaconda.org/conda-forge/gmt/files)
using the following command:

`mamba install -c conda-forge gmt=X.Y.Z`
:tada: [GMT X.Y.Z](https://github.com/GenericMappingTools/gmt/releases/tag/X.Y.Z) has been released! It is installable from the [conda-forge channel](https://anaconda.org/conda-forge/gmt/files) using the following command:
```
mamba install -c conda-forge gmt=X.Y.Z
```

<!-- Please add specific checklist items for the tests, xfail pytest markers, and deprecated syntax that need to be updated. -->

Expand All @@ -29,13 +28,19 @@ using the following command:
- [ ] Update GMT 6.x minor version for `extlinks` urls in `doc/conf.py`
- [ ] Fix failing tests (1 or more PRs)
- [ ] Fix failing doctests reported in the ["Doctest" workflow](https://github.com/GenericMappingTools/pygmt/actions/workflows/ci_doctests.yaml)
- [ ] Fix [xfail](https://docs.pytest.org/en/stable/skipping.html#xfail-mark-test-functions-as-expected-to-fail) pytest markers on tests that are now xpass
- [ ] Run `grep "# TODO(GMT.*)" **/*.py` to find TODO items related to GMT
Copy link
Member

@weiji14 weiji14 Oct 16, 2025

Choose a reason for hiding this comment

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

This grep statement doesn't seem to handle leading whitespaces?

Copy link
Member Author

@seisman seisman Oct 16, 2025

Choose a reason for hiding this comment

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

It works well with leading whitespaces:

$ grep "# TODO(GMT.*)" **/*.py
pygmt/clib/session.py:            # TODO(GMT>6.5.0): Remove the workaround for upstream bug in GMT<=6.5.0.
pygmt/src/plot3d.py:    # TODO(GMT>6.5.0): Remove the note for the upstream bug of the "straight_line"
pygmt/src/plot.py:    # TODO(GMT>6.5.0): Remove the note for the upstream bug of the "straight_line"
pygmt/tests/test_clib_virtualfile_in.py:# TODO(GMT>6.5.0): Remove the xfail marker for GMT<=6.5.0.
pygmt/tests/test_datasets_earth_relief.py:# TODO(GMT X.Y.Z): Upstream bug which is not fixed yet.
pygmt/tests/test_grdimage.py:# TODO(GMT>6.5.0): Remove the xfail marker for GMT<=6.5.0.

Copy link
Member

@weiji14 weiji14 Oct 16, 2025

Choose a reason for hiding this comment

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

Hmm, it doesn't seem to work for me on my bash shell in Linux. But usually I just use my IDE's 'Find in Project' anyway.

Copy link
Member Author

@seisman seisman Oct 16, 2025

Choose a reason for hiding this comment

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

You're right, **/*.py doesn't work well for Bash (I'm using zsh).

Maybe we should use the following command. Also note that we may have TODO comments in

$ grep -r "# TODO(GMT.*)" --include="*.py" .
./pygmt/clib/session.py:            # TODO(GMT>6.5.0): Remove the workaround for upstream bug in GMT<=6.5.0.
./pygmt/tests/test_datasets_earth_relief.py:# TODO(GMT X.Y.Z): Upstream bug which is not fixed yet.
./pygmt/tests/test_grdimage.py:# TODO(GMT>6.5.0): Remove the xfail marker for GMT<=6.5.0.
./pygmt/tests/test_clib_virtualfile_in.py:# TODO(GMT>6.5.0): Remove the xfail marker for GMT<=6.5.0.
./pygmt/src/plot3d.py:    # TODO(GMT>6.5.0): Remove the note for the upstream bug of the "straight_line"
./pygmt/src/plot.py:    # TODO(GMT>6.5.0): Remove the note for the upstream bug of the "straight_line"

- [ ] Remove related workarounds/patches
- [ ] Fix tests with pytest `xfail`/`skipif` markers that now pass
- [ ] Update this checklist if necessary

**To-Do for bumping the minimum required GMT version**:

- [ ] Bump the minimum required GMT version (1 PR)
- [ ] Update `required_gmt_version` in `pygmt/clib/__init__.py`
- [ ] Remove unsupported GMT version from `.github/workflows/ci_tests_legacy.yaml`
- [ ] Ensure minimum required version is correct in `doc/minversions.md`
- [ ] Remove [xfail](https://docs.pytest.org/en/stable/skipping.html#xfail-mark-test-functions-as-expected-to-fail) pytest markers on tests that are now xpass
- [ ] Run `grep "# TODO(GMT.*)" **/*.py` to find TODO items related to GMT
- [ ] Remove related workarounds/patches
- [ ] Fix tests with pytest `xfail`/`skipif` markers that now pass
- [ ] Update deprecated syntax in source code and examples based on the [GMT Changelog](https://docs.generic-mapping-tools.org/latest/changes.html)
- [ ] Update this checklist if necessary