Create new job to make cancelled jobs as failure jobs in CI runner#780
Create new job to make cancelled jobs as failure jobs in CI runner#780ThreeMonth03 wants to merge 1 commit into
Conversation
ThreeMonth03
left a comment
ThreeMonth03
left a comment
There was a problem hiding this comment.
@yungyuc Please review this pull request when you are available. Thanks.
| send_email_on_failure: | ||
| needs: [nouse_install, fail_on_cancelled_jobs] | ||
| # Run if any of the dependencies failed or timed out in master branch | ||
| if: ${{ always() && contains(needs.*.result, 'failure') && github.ref_name == 'master' && github.event.repository.fork == false }} | ||
| uses: ./.github/workflows/send_email_on_fail.yml | ||
| with: | ||
| job_results: | | ||
| - nouse_install: ${{ needs.nouse_install.result }} | ||
| - fail_on_cancelled_jobs: ${{ needs.fail_on_cancelled_jobs.result }} |
There was a problem hiding this comment.
When a job is cancelled, a notified email would be sent now.
| send_email_on_failure: | ||
| fail_on_cancelled_jobs: | ||
| needs: [nouse_install] | ||
| # Run if any of the dependencies failed in master branch | ||
| if: ${{ always() }} | ||
| runs-on: ubuntu-24.04 | ||
| steps: | ||
| - name: Fail on cancelled jobs | ||
| run: | | ||
| result="${{ needs.nouse_install.result }}" | ||
| echo "nouse_install: ${result}" | ||
| if [ "${result}" = "cancelled" ]; then | ||
| exit 1 | ||
| fi |
There was a problem hiding this comment.
We cannot make a time-out job as a failure job easily. There are two workaround method.
The first opinion is to create a new job to monitor the cancelled jobs, and it would raise failure when there is a cancelled job.
The second opinion is to time the process by a timer. If the process times out, the timer would return 1.
I prefer the first opinion, so I create a new job to monitor the cancelled jobs.
There was a problem hiding this comment.
This would work, but is not as elegant as I hoped for.
If there is not a better way, I would take it. But I hope there is.
yungyuc
left a comment
yungyuc
left a comment
There was a problem hiding this comment.
@ExplorerRay @chestercheng Could you please help brainstorm?
| fail_on_cancelled_jobs: | ||
| needs: [standalone_buffer, build, build_windows] | ||
| # Run if any of the dependencies failed in master branch | ||
| if: ${{ always() }} |
There was a problem hiding this comment.
Is it necessary to write the if, if it always() happens?
There was a problem hiding this comment.
Yes, it is. It's an interesting technique. See this reference.
If a job fails or is skipped, all jobs that need it are skipped unless the jobs use a conditional expression that causes the job to continue. If a run contains a series of jobs that need each other, a failure or skip applies to all jobs in the dependency chain from the point of failure or skip onwards. If you would like a job to run even if a job it is dependent on did not succeed, use the always() conditional expression in jobs.<job_id>.if.
In other words, if we remove if: ${{ always() }}, this job would be skipped if the jobs in needs are cancelled or failed. However, we don't want to skip this job at any time, so we need to add if: ${{ always() }}.
| send_email_on_failure: | ||
| fail_on_cancelled_jobs: | ||
| needs: [nouse_install] | ||
| # Run if any of the dependencies failed in master branch | ||
| if: ${{ always() }} | ||
| runs-on: ubuntu-24.04 | ||
| steps: | ||
| - name: Fail on cancelled jobs | ||
| run: | | ||
| result="${{ needs.nouse_install.result }}" | ||
| echo "nouse_install: ${result}" | ||
| if [ "${result}" = "cancelled" ]; then | ||
| exit 1 | ||
| fi |
There was a problem hiding this comment.
This would work, but is not as elegant as I hoped for.
If there is not a better way, I would take it. But I hope there is.
2 participants
In issue #772, we notice that when a job times out, it would be cancelled instead of fail.
Therefore, this pull request is to create new job, that could monitor cancelled jobs, and make cancelled jobs as failure jobs in CI runner.