-
Notifications
You must be signed in to change notification settings - Fork 229
Add slash command '/test-gmt-dev' to test GMT dev version #831
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
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please also update the part in https://github.com/GenericMappingTools/pygmt/blob/v0.2.1/MAINTENANCE.md#github-actions which says:
ci_tests_dev.yaml (GMT Latest Tests on Linux/macOS/Windows).
This is only triggered when a review is requested or re-requested on a PR. It is also scheduled to run daily on the master branch.
to mention that the test can also be triggered using /test-gmt-master
.
Note: you may find the following status page in PR seisman#2. These "GMT Latest Tests" status were triggered by "mark it ready for review", not by the slash command /test-gmt-master.
image
One possible solution is: when the workflow is triggered by slash commands, we can let the workflow leave a comment saying that "The workflow is running at https://github.com/GenericMappingTools/pygmt/actions/runs/XXXXX"
Might be complicated trying to code up the chatbot comment (though it will be nice, if not a bit annoying). How often will we need to keep triggering GMT Latest Tests? If it's not too often I think it's fine to just navigate to the Actions tab manually.
We probably only want to trigger the GMT Latest Tests when a PR is close to merging. We can navigate to the Actions tab manually and see how it goes. |
@@ -21,5 +21,6 @@ jobs: | |||
token: ${{ steps.generate-token.outputs.token }} | |||
commands: | | |||
format | |||
test-gmt-master |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
test-gmt-master | |
test-gmt-dev |
What do you think about changing the name to 'latest' to match the Github Actions name?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
When we say "the latest GMT", we usually mean "the latest stable GMT release" (i.e., 6.1.1).
What about "GMT Dev Tests" and /test-gmt-dev
?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yep, dev sounds good and is shorter. Please remember to change the PR title too.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Co-authored-by: Wei Ji <[email protected]> Co-authored-by: Wei Ji <[email protected]>
…pingTools#831) * Add slash command '/test-gmt-dev' to test GMT dev version * Remove 'review_requested' from the triggering condition * Update pull request template * Update maintenance guide * Rename workflow to 'GMT Dev Tests' Co-authored-by: Wei Ji <[email protected]>
Description of proposed changes
This PR adds the slash command
/test-gmt-dev
which can trigger the GMT Dev Tests workflow. So we can test GMT master branch anytime, without requesting reviews from other maintainers or teams (Also fixes #828).As you may know/remember, the slash command can only read the configurations in the master branch, so we can't test this PR unless we merge it into the master branch.
To test this PR, I forked the PyGMT repository to my own account (https://github.com/seisman/pygmt), and made changes directly to my own master branch.
If you compare my master branch and the PyGMT master branch, you will see my master branch is 2 commits ahead of PyGMT master branch. The two commits are:
To confirm that everything works well, I opened an example PR in my own fork (https://github.com/seisman/pygmt/pull/2). Please go to that PR to see how it works.
TODO:
review_requested
condition from the workflow, so that we can run the GMT Latest Tests workflow by marking it "ready for review", or using the slash command/test-gmt-dev
(done in 4a22c59)Known issues:
The "GMT Latest Tests" triggered by

/test-gmt-master
won't show the workflow status in the status summary page (like the screenshot below), so we have to go the the "Actions" page to find the testing results.Note: you may find the following status page in PR https://github.com/seisman/pygmt/pull/2. These "GMT Latest Tests" status were triggered by "mark it ready for review", not by the slash command

/test-gmt-master
.One possible solution is: when the workflow is triggered by slash commands, we can let the workflow leave a comment saying that "The workflow is running at https://github.com/GenericMappingTools/pygmt/actions/runs/XXXXX"
Fixes #828.
Reminders
make format
andmake check
to make sure the code follows the style guide.doc/api/index.rst
.Notes
/format
in the first line of a comment to lint the code automatically