Skip to content

jobs.<job_id>.strategy.fail-fast docs don't specify wheather "all jobs" refers to the workflow, or the job matrix #16401

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.

Sign up for GitHub

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

Jump to bottom
Closed
1 task done
michaelosthege opened this issue Mar 20, 2022 · 5 comments · Fixed by #16806
Closed
1 task done

jobs.<job_id>.strategy.fail-fast docs don't specify wheather "all jobs" refers to the workflow, or the job matrix #16401

michaelosthege opened this issue Mar 20, 2022 · 5 comments · Fixed by #16806
Labels
actions This issue or pull request should be reviewed by the docs actions team content This issue or pull request belongs to the Docs Content team good first issue Good for newcomers help wanted Anyone is welcome to open a pull request to fix this issue

Comments

@michaelosthege
Copy link
Contributor

Code of Conduct

What article on docs.github.com is affected?

The jobs.<job_id>.strategy.fail-fast section:

https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstrategyfail-fast

What part(s) of the article would you like to see updated?

I had (and still have) the following question, which is not answered by the corresponding docs section:

Will a failing job with a fail-fast: true setting in its matrix cancel all jobs within the workflow, or just the jobs within the same job matrix?

I think there are scenarios where either behavior is desired.

Additional information

I'm considering to use the fail-fast seting to cancel the entire workflow if the pre-commit job fails, but while keeping their execution parallelized.
@michaelosthege michaelosthege added the content This issue or pull request belongs to the Docs Content team label Mar 20, 2022
@welcome
Copy link

welcome bot commented Mar 20, 2022

Thanks for opening this issue. A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines.

@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label Mar 20, 2022
@michaelosthege michaelosthege mentioned this issue Mar 20, 2022
Closed
@michaelosthege michaelosthege changed the title jobs.<job_id>.strategy.fail-fast docs don't specify wher "all jobs" refers to the workflow, or the job matrix jobs.<job_id>.strategy.fail-fast docs don't specify wheather "all jobs" refers to the workflow, or the job matrix Mar 20, 2022
@ramyaparimi ramyaparimi added actions This issue or pull request should be reviewed by the docs actions team waiting for review Issue/PR is waiting for a writer's review and removed triage Do not begin working on this issue until triaged by the team labels Mar 21, 2022
@ramyaparimi
Copy link
Contributor

@michaelosthege
Thanks so much for opening a PR! I'll get this triaged for review ⚡

@michaelosthege
Copy link
Contributor Author

@michaelosthege Thanks so much for opening a PR! I'll get this triaged for review ⚡

The linked PR is not a PR to the docs (I still don't know the answer to my question) but the issue in our project that's tracking our effort to fast-fail our test jobs when the linting job fails.

@ramyaparimi
Copy link
Contributor

@michaelosthege

Ops! I meant to say thank you for opening this issue 💛 I apologize for the confusion 💖

@ramyaparimi ramyaparimi added the needs SME This proposal needs review from a subject matter expert label Mar 25, 2022
@lucascosti
Copy link
Contributor

👋 @michaelosthege

Will a failing job with a fail-fast: true setting in its matrix cancel all jobs within the workflow, or just the jobs within the same job matrix?

It cancels just the jobs within the same matrix. I agree that the current wording does not make this super clear.

We could update to be something like the following:

When jobs.<job_id>.strategy.fail-fast is set to true, GitHub cancels all in-progress jobs in the matrix if any matrix job fails.

You (or anyone else!) can feel free to open a PR to make the ☝️ change.

@lucascosti lucascosti added help wanted Anyone is welcome to open a pull request to fix this issue good first issue Good for newcomers and removed waiting for review Issue/PR is waiting for a writer's review needs SME This proposal needs review from a subject matter expert labels Apr 4, 2022
michaelosthege added a commit to michaelosthege/docs that referenced this issue Apr 4, 2022
@michaelosthege
Clarify which jobs are canceled with fail-fast
e473613 
Closes github#16401
@michaelosthege michaelosthege mentioned this issue Apr 4, 2022
Merged
5 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
actions This issue or pull request should be reviewed by the docs actions team content This issue or pull request belongs to the Docs Content team good first issue Good for newcomers help wanted Anyone is welcome to open a pull request to fix this issue
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Clarify which jobs are canceled with fail-fast michaelosthege/docs
3 participants
@lucascosti @michaelosthege @ramyaparimi