Skip to content

Commit 2b77309

Browse files
seismanweiji14
andauthored
Update the issue template for bumping GMT versions (#4167)
Co-authored-by: Wei Ji <[email protected]>
1 parent 8259159 commit 2b77309

File tree

2 files changed

+13
-8
lines changed

2 files changed

+13
-8
lines changed

.github/ISSUE_TEMPLATE/4-release_checklist.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ assignees: ''
2424
- [ ] Review the ["PyGMT Team" page](https://www.pygmt.org/dev/team.html)
2525
- [ ] README looks good on TestPyPI. Visit [TestPyPI](https://test.pypi.org/project/pygmt/#history), click the latest pre-release, and check the homepage.
2626
- [ ] Check to ensure that:
27-
- [ ] Deprecated workarounds/codes/tests are removed. Run `grep "# TODO" **/*.py` to find all potential TODOs.
27+
- [ ] Deprecated workarounds/codes/tests are removed. Run `grep -r "# TODO" --include="*.py" .` to find all potential TODOs.
2828
- [ ] All tests pass in the ["GMT Legacy Tests" workflow](https://github.com/GenericMappingTools/pygmt/actions/workflows/ci_tests_legacy.yaml)
2929
- [ ] All tests pass in the ["GMT Dev Tests" workflow](https://github.com/GenericMappingTools/pygmt/actions/workflows/ci_tests_dev.yaml)
3030
- [ ] All tests pass in the ["Doctests" workflow](https://github.com/GenericMappingTools/pygmt/actions/workflows/ci_doctests.yaml)

.github/ISSUE_TEMPLATE/5-bump_gmt_checklist.md

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,10 @@ assignees: ''
77

88
---
99

10-
:tada: [GMT X.Y.Z](https://github.com/GenericMappingTools/gmt/releases/tag/X.Y.Z) has been released!
11-
It is installable from the [conda-forge channel](https://anaconda.org/conda-forge/gmt/files)
12-
using the following command:
13-
14-
`mamba install -c conda-forge gmt=X.Y.Z`
10+
: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:
11+
```
12+
mamba install -c conda-forge gmt=X.Y.Z
13+
```
1514

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

@@ -29,13 +28,19 @@ using the following command:
2928
- [ ] Update GMT 6.x minor version for `extlinks` urls in `doc/conf.py`
3029
- [ ] Fix failing tests (1 or more PRs)
3130
- [ ] Fix failing doctests reported in the ["Doctest" workflow](https://github.com/GenericMappingTools/pygmt/actions/workflows/ci_doctests.yaml)
32-
- [ ] 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
31+
- [ ] Run `grep -r "# TODO(GMT.*)" --include="*.py" .` to find TODO items related to GMT
32+
- [ ] Remove related workarounds/patches
33+
- [ ] Fix tests with pytest `xfail`/`skipif` markers that now pass
34+
- [ ] Update this checklist if necessary
3335

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

3638
- [ ] Bump the minimum required GMT version (1 PR)
3739
- [ ] Update `required_gmt_version` in `pygmt/clib/__init__.py`
3840
- [ ] Remove unsupported GMT version from `.github/workflows/ci_tests_legacy.yaml`
3941
- [ ] Ensure minimum required version is correct in `doc/minversions.md`
40-
- [ ] 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
42+
- [ ] Run `grep -r "# TODO(GMT.*)" --include="*.py" .` to find TODO items related to GMT
43+
- [ ] Remove related workarounds/patches
44+
- [ ] Fix tests with pytest `xfail`/`skipif` markers that now pass
4145
- [ ] Update deprecated syntax in source code and examples based on the [GMT Changelog](https://docs.generic-mapping-tools.org/latest/changes.html)
46+
- [ ] Update this checklist if necessary

0 commit comments

Comments
 (0)