add job rerun action #27210
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,118 @@ | ||
| name: "Rerun Job Action" | ||
| description: Re-runs a job that is attached to the PR as Check Run | ||
| inputs: | ||
| pull_request_url: | ||
| description: "The URL of the PR" | ||
| required: true | ||
| github_repository: | ||
| description: "The GitHub repository" | ||
| required: true | ||
| github_token: | ||
| description: "The GitHub token" | ||
| required: true | ||
| github_job: | ||
| description: "The GitHub job" | ||
| required: true | ||
| github_current_run_id: | ||
| description: "The GitHub current run id. Not the same that is fetched in this action" | ||
| required: true | ||
|
|
||
|
|
||
| runs: | ||
| using: composite | ||
| steps: | ||
| - name: Get Last Commit SHA | ||
| shell: bash | ||
| run: | | ||
| URL=${{inputs.pull_request_url}}/commits | ||
| PRSHA=$(curl \ | ||
| -H 'Authorization: Bearer ${{inputs.github_token}}' \ | ||
| -H "Accept: application/vnd.github+json" \ | ||
| -H "X-GitHub-Api-Version: 2022-11-28" \ | ||
| -s $URL | jq -r '.[-1].sha' ) | ||
| echo prsha=$PRSHA >> $GITHUB_ENV | ||
|
|
||
| - name: Get Status for PR Job | ||
| id: get_status | ||
| shell: bash | ||
| run: | | ||
| URL="${{github.api_url}}/repos/${{inputs.github_repository}}/commits/${{env.prsha}}/check-runs" | ||
| STATUS=$(curl \ | ||
| -H 'Authorization: Bearer ${{inputs.github_token}}' \ | ||
| -H "Accept: application/vnd.github+json" \ | ||
| -H "X-GitHub-Api-Version: 2022-11-28" \ | ||
| -s $URL | jq -r '.check_runs | .[] | select(.name=="${{inputs.github_job}}") | .status') | ||
| echo status=$STATUS >> $GITHUB_ENV | ||
|
|
||
| - name: Get Conclusion for PR Job | ||
|
There was a problem hiding this comment. Can we consolidate this with the last one since we're making the same request twice and just pulling out a different field? There was a problem hiding this comment. Leftover from PoC, will consolidate it |
||
| id: get_conclusion | ||
| shell: bash | ||
| run: | | ||
| URL="${{github.api_url}}/repos/${{inputs.github_repository}}/commits/${{env.prsha}}/check-runs" | ||
| CONCLUSION=$(curl \ | ||
| -H 'Authorization: Bearer ${{inputs.github_token}}' \ | ||
| -H "Accept: application/vnd.github+json" \ | ||
| -H "X-GitHub-Api-Version: 2022-11-28" \ | ||
| -s $URL | jq -r '.check_runs | .[] | select(.name=="${{inputs.github_job}}") | .conclusion') | ||
| echo conclusion=$CONCLUSION >> $GITHUB_ENV | ||
|
|
||
| - name: Enable Rerun | ||
| if: ${{env.status == 'completed' && (env.conclusion == 'success' || env.conclusion == 'skipped')}} | ||
|
There was a problem hiding this comment. A comment explaining our logic here would probably help (basically, we can't use the rerun api if the status is completed and it succeeded or was skipped). I guess this does mean that trigger phrases won't status correctly for jobs that have already succeeded or are skipped, I think that's fine though There was a problem hiding this comment. Succeeded or Skipped will not be re-run , but a new instance of Job will appear in actions. Ill leave a comment |
||
| shell: bash | ||
| run: echo rerun=false >> $GITHUB_ENV | ||
|
|
||
| - name: Get Check Suide ID | ||
volatilemolotov marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| if: ${{env.rerun != 'false' }} | ||
| shell: bash | ||
| run: | | ||
| URL="${{github.api_url}}/repos/${{inputs.github_repository}}/commits/${{env.prsha}}/check-runs" | ||
| CHECK_SUITE_ID=$(curl \ | ||
| -H 'Authorization: Bearer ${{inputs.github_token}}' \ | ||
| -H "Accept: application/vnd.github+json" \ | ||
| -H "X-GitHub-Api-Version: 2022-11-28" \ | ||
| -s $URL | jq -r '.check_runs | .[] | select(.name=="${{inputs.github_job}}") | .check_suite.id') | ||
| echo check_suite_id=$CHECK_SUITE_ID >> $GITHUB_ENV | ||
|
|
||
| - name: Get Run ID | ||
| if: ${{env.rerun != 'false' }} | ||
| shell: bash | ||
| run: | | ||
| URL="${{github.api_url}}/repos/${{inputs.github_repository}}/actions/runs?check_suite_id=${{env.check_suite_id}}" | ||
| RUN_ID=$(curl \ | ||
| -H 'Authorization: Bearer ${{inputs.github_token}}' \ | ||
| -H "Accept: application/vnd.github+json" \ | ||
| -H "X-GitHub-Api-Version: 2022-11-28" \ | ||
| -s $URL | jq -r '.workflow_runs | .[0] | .id') | ||
| echo run_id=$RUN_ID >> $GITHUB_ENV | ||
|
|
||
| - name: Get Job ID | ||
| if: ${{env.rerun != 'false' }} | ||
| shell: bash | ||
| run: | | ||
| URL="${{github.api_url}}/repos/${{inputs.github_repository}}/actions/runs/${{env.run_id}}/jobs" | ||
| JOB_ID=$(curl \ | ||
| -H 'Authorization: Bearer ${{inputs.github_token}}' \ | ||
| -H "Accept: application/vnd.github+json" \ | ||
| -H "X-GitHub-Api-Version: 2022-11-28" \ | ||
| -s $URL | jq -r '.jobs | .[] | select(.name=="${{inputs.github_job}}") | .id ') | ||
| echo job_id=$JOB_ID >> $GITHUB_ENV | ||
|
|
||
| - name: Trigger Re-run | ||
| if: ${{env.rerun != 'false' }} | ||
| shell: bash | ||
| run: | | ||
| URL="${{github.api_url}}/repos/${{inputs.github_repository}}/actions/jobs/${{env.job_id}}/rerun" | ||
| curl -X POST \ | ||
| -H 'Authorization: Bearer ${{inputs.github_token}}' \ | ||
| -H "Accept: application/vnd.github+json" \ | ||
| -H "X-GitHub-Api-Version: 2022-11-28" \ | ||
| -s $URL | ||
|
|
||
| - name: Exit rest of the run | ||
| if: ${{env.rerun != 'false' }} | ||
| shell: bash | ||
| run: | | ||
| gh run cancel ${{ inputs.github_current_run_id }} | ||
| gh run watch ${{ inputs.github_current_run_i }} | ||
| env: | ||
| GITHUB_TOKEN: ${{ inputs.github_token }} | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
I think this will need the Apache header (can copy/paste from any workflow).
Also, could you add a brief comment description of the purpose of this composite action, including how to use it (ideally with a code snippet) and required permissions (again ideally with a code snippet). I think the permissions should be
repo: read(even if we don't need this, virtually every job will),pull-requests: write, andchecks: read(might actually need to bestatusesinstead ofchecks?)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.
Forgot the header, Will add it.
Regarding permissions i was thinking to add that and explain in some doc showing implementation of the action. Or i can do it here. Put README.MD here?
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.
I'm fine leaving it for the doc. When we add that, we should add a link from here. I'd still like to have a basic 1 sentence summary of this action in the file though.