Add issue template with checklist for bumping the minimum required GM…

…T version (GenericMappingTools#1630) * Add issue template with checklist for bumping the minimum required GMT version Co-authored-by: Will Schlitzer <[email protected]> Co-authored-by: Dongdong Tian <[email protected]>
sixy6e · Dec 21, 2022 · 6803096 · 6803096
1 parent a22432c
commit 6803096
Showing 1 changed file with 29 additions and 0 deletions.
diff --git a/.github/ISSUE_TEMPLATE/bump_gmt_checklist.md b/.github/ISSUE_TEMPLATE/bump_gmt_checklist.md
@@ -0,0 +1,29 @@
+---
+name: Bump GMT version checklist
+about: Checklist for bumping the minimum required GMT version.
+title: Bump to GMT X.Y.Z
+labels: maintenance
+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:
+
+`conda 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. -->
+
+**To-Do**:
+- [ ] Bump the minimum required GMT version (1 PR)
+  - [ ] Update `.github/workflows/cache_data.yaml`
+  - [ ] Update `.github/workflows/ci_docs.yml`
+  - [ ] Update `.github/workflows/ci_tests.yaml`
+  - [ ] Update `doc/install.rst`
+  - [ ] Update `environment.yml`
+  - [ ] Update `required_version` in `pygmt/clib/session.py`
+  - [ ] Update `test_get_default` in `pygmt/tests/test_clib.py`
+  - [ ] Update compatibility table in `README.rst`
+- [ ] Fix failing tests (1 or more PRs)
+- [ ] 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
+- [ ] Update deprecated syntax in source code and examples based on the [GMT Changelog](https://docs.generic-mapping-tools.org/latest/changes.html)