Feature #2816 enhance workflow dispatch testing #2818
Conversation
…ay the repo that triggered the workflow on workflow_dispatch events. Preserve the behavior of pull_request and push events by displaying the PR title or head commit message respectively
… the repo/title was not provided. Update description of workflow_dispatch argument to describe what it can be used for when triggering manually. Only run step to build URL to commit that triggered workflow if it was triggered from an external repo
… was added to handle custom workflow run titles
There was a problem hiding this comment.
@georgemccabe these are great improvements. Thanks a lot for working on them. The only way I can think it improve them would be in the scenario when the testing workflow was triggered by changes in another repository, like this one. The title is currently dtcenter/MET.
The Print GitHub Values for Reference job output already includes this sha from the triggering repo:
"inputs": {
"repository": "dtcenter/MET",
"sha": "1b58927e0b3d077ae3cbbe96dfd6d4c73bd2c27e"
},
It would be convenient if the title automatically added a link directly to that SHA, like:
dtcenter/MET@bd2c27e
I'm going to state that I approve of these changes as is.
And if enhancing that title to link to the source sha is easily done, that'd be even better!
|
@JohnHalleyGotway, I don't think there is a way to create a link within the title since the title itself is a link to the workflow logs. However, from the link you provided, you can expand the step that is titled Build URL for commit that triggered workflow get a link to the commit in the external repo. |
* per #2816, update title of workflow displayed in Actions tab to display the repo that triggered the workflow on workflow_dispatch events. Preserve the behavior of pull_request and push events by displaying the PR title or head commit message respectively * fix logic for run-name * Update event info to note that the workflow was triggered manually if the repo/title was not provided. Update description of workflow_dispatch argument to describe what it can be used for when triggering manually. Only run step to build URL to commit that triggered workflow if it was triggered from an external repo * add optional argument for workflow_dispatch to specify the title of the workflow run * revert change to repository argument description since title argument was added to handle custom workflow run titles
The same changes should be made to main_v6.0 so the updates to the workflow_dispatch drop down for testing workflow will include these changes when main_v6.0 becomes the default branch. It is not necessary to add this for main_v5.1 since we are so close to the release.
Pull Request Testing
Confirmed that expected workflow run titles result from different runs:
Do these changes include sufficient documentation updates, ensuring that no errors or warnings exist in the build of the documentation? [Yes]
Do these changes include sufficient testing updates? [Yes]
Will this PR result in changes to the test suite? [No]
If yes, describe the new output and/or changes to the existing output:
Do these changes introduce new SonarQube findings? [No]
If yes, please describe:
Please complete this pull request review by 12/12/2024.
Pull Request Checklist
See the METplus Workflow for details.
Select: Reviewer(s) and Development issue
Select: Milestone as the version that will include these changes
Select: Coordinated METplus-X.Y Support project for bugfix releases or METplus-Wrappers-X.Y.Z Development project for official releases