Skip to content
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.

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

Add a workflow and Makefile target to test old GMT versions every Tuesday #2079

Merged
merged 11 commits into from
Sep 14, 2022

Conversation

seisman
Copy link
Member

@seisman seisman commented Aug 23, 2022

Description of proposed changes

To test PyGMT with old GMT versions, a new Makefile target and a new workflow are added in this PR.

Makefile target test_no_images

Because the baseline images usually have slight changes for different GMT versions, it makes little sense to compare the baseline images generated by GMT 6.4 when running the tests with GMT 6.3. However, we still want to run these image-building tests to make sure they don't crash or raise errors. This is done by NOT adding the --mpl option to pytest.

New workflow "GMT Backwards Tests"

This workflow is modified from the "GMT Dev Tests" workflow. It will run when a PR is marked ready for review and will run every Tuesday.

Fixes #1991.

Reminders

  • Run make format and make check to make sure the code follows the style guide.
  • Add tests for new features or tests that would have caught the bug that you're fixing.
  • Add new public functions/methods/classes to doc/api/index.rst.
  • Write detailed docstrings for all functions/methods.
  • If wrapping a new module, open a 'Wrap new GMT module' issue and submit reasonably-sized PRs.
  • If adding new functionality, add an example to docstrings or tutorials.

Slash Commands

You can write slash commands (/command) in the first line of a comment to perform
specific operations. Supported slash commands are:

  • /format: automatically format and lint the code
  • /test-gmt-dev: run full tests on the latest GMT development version

@seisman seisman changed the title Add a workflow to test old GMT versions on Monday/Wednesday/Friday WIP Add a workflow to test old GMT versions on Monday/Wednesday/Friday Aug 23, 2022
@seisman seisman marked this pull request as ready for review August 23, 2022 13:29
@seisman seisman added the maintenance Boring but important stuff for the core devs label Aug 23, 2022
@seisman seisman added this to the 0.8.0 milestone Aug 23, 2022
@seisman seisman marked this pull request as draft August 23, 2022 15:59
@seisman seisman marked this pull request as ready for review August 23, 2022 15:59
@seisman seisman changed the title WIP Add a workflow to test old GMT versions on Monday/Wednesday/Friday WIP Add a workflow and a Makefile target to test old GMT versions on Monday/Wednesday/Friday Aug 24, 2022
.github/workflows/ci_tests_backward.yaml Outdated Show resolved Hide resolved
.github/workflows/ci_tests_backward.yaml Outdated Show resolved Hide resolved
.github/workflows/ci_tests_backward.yaml Outdated Show resolved Hide resolved
.github/workflows/ci_tests_backward.yaml Outdated Show resolved Hide resolved
.github/workflows/ci_tests_backward.yaml Outdated Show resolved Hide resolved
.github/workflows/ci_tests_backward.yaml Outdated Show resolved Hide resolved
@seisman seisman force-pushed the test-old-gmt-versions branch from 9f19869 to 8d3cf45 Compare August 28, 2022 02:03
@seisman seisman changed the title WIP Add a workflow and a Makefile target to test old GMT versions on Monday/Wednesday/Friday Add a workflow and a Makefile target to test old GMT versions on Monday/Wednesday/Friday Aug 28, 2022
@seisman seisman added the needs review This PR has higher priority and needs review. label Aug 28, 2022
@seisman seisman changed the title Add a workflow and a Makefile target to test old GMT versions on Monday/Wednesday/Friday Add a workflow and a Makefile target to test old GMT versions on every Tuesday Aug 29, 2022
.github/workflows/ci_tests_backward.yaml Outdated Show resolved Hide resolved
.github/workflows/ci_tests_backward.yaml Outdated Show resolved Hide resolved
@seisman seisman requested review from maxrjones and weiji14 September 2, 2022 14:39
@seisman
Copy link
Member Author

seisman commented Sep 9, 2022

Ping @weiji14 and @maxrjones for another round of review.

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.

Some suggestions to run these tests on lower versions of Python and Operating Systems.

@@ -0,0 +1,105 @@
# This workflow installs PyGMT and runs tests with old GMT versions

name: GMT Backward Tests
Copy link
Member

Choose a reason for hiding this comment

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

Not so sure if 'backward' is a good word, how about 'legacy' (https://en.wikipedia.org/wiki/Legacy_system)? Maybe we need to ask a native English speaker 🙂

Suggested change
name: GMT Backward Tests
name: GMT Legacy Tests

Copy link
Member Author

Choose a reason for hiding this comment

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

Legacy sounds good and let's wait for some inputs for native English speakers.

Copy link
Member Author

Choose a reason for hiding this comment

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

Done in be81f36

.github/workflows/ci_tests_backward.yaml Outdated Show resolved Hide resolved
.github/workflows/ci_tests_backward.yaml Outdated Show resolved Hide resolved
@weiji14 weiji14 changed the title Add a workflow and a Makefile target to test old GMT versions on every Tuesday Add a workflow and Makefile target to test old GMT versions every Tuesday Sep 9, 2022
@@ -0,0 +1,105 @@
# This workflow installs PyGMT and runs tests with old GMT versions
Copy link
Member Author

Choose a reason for hiding this comment

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

Remember to rename the workflow file if we decide to call it "GMT Legacy Tests"

Copy link
Member Author

Choose a reason for hiding this comment

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

Done in be81f36.

.github/workflows/ci_tests_legacy.yaml Outdated Show resolved Hide resolved
@weiji14 weiji14 added final review call This PR requires final review and approval from a second reviewer and removed needs review This PR has higher priority and needs review. labels Sep 13, 2022
@seisman seisman merged commit 0337138 into main Sep 14, 2022
@seisman seisman deleted the test-old-gmt-versions branch September 14, 2022 15:18
@seisman seisman removed the final review call This PR requires final review and approval from a second reviewer label Sep 14, 2022
sixy6e pushed a commit to sixy6e/pygmt that referenced this pull request Dec 21, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
maintenance Boring but important stuff for the core devs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Allow brave users to run PyGMT with old GMT versions?
4 participants