Skip to content
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

Provide more visibility for the article on skipped but required checks #16048

Closed
1 task done
toonn opened this issue Mar 4, 2022 · 12 comments · Fixed by #16173
Closed
1 task done

Provide more visibility for the article on skipped but required checks #16048

toonn opened this issue Mar 4, 2022 · 12 comments · Fixed by #16173
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 help wanted Anyone is welcome to open a pull request to fix this issue repositories Content related to repositories

Comments

@toonn
Copy link
Contributor

toonn commented Mar 4, 2022

Code of Conduct

What article on docs.github.com is affected?

Handling skipped but required checks

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

This article is really hard to find. Maybe it can be part of the normal Actions documentation here. I've been looking for a way to do this for months now and it didn't turn up until I asked someone else whether they knew if it was even possible.

Additional information

No response
@toonn toonn added the content This issue or pull request belongs to the Docs Content team label Mar 4, 2022
@welcome
Copy link

welcome bot commented Mar 4, 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 4, 2022
@fejalpathan

This comment was marked as spam.

Sign in to view
@ramyaparimi ramyaparimi added actions This issue or pull request should be reviewed by the docs actions team repositories Content related to repositories 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 actions This issue or pull request should be reviewed by the docs actions team labels Mar 7, 2022
@ramyaparimi
Copy link
Contributor

@toonn
Thanks so much for opening an issue! I'll triage this for the team to take a look 👀

@david-bain
Copy link

While you are at it can you please check the validity of the content or if there is a bug in the implementation?
I had a check that was skipped due to a needs job failing and the skip counted as a pass for merging, not what it said in the document. For clarity, the needs referred to a matrix job where some of the instances failed and I could reliably replicate this bug.

@janiceilene janiceilene added the actions This issue or pull request should be reviewed by the docs actions team label Mar 8, 2022
@skedwards88
Copy link
Contributor

Thank you for opening this issue! I agree that it would be good to make this article more discoverable. I suggest adding a link to Troubleshooting required status checks from Triggering a workflow, where we introduce filtering. You or anyone is welcome to open a PR to address this.

@skedwards88 skedwards88 added help wanted Anyone is welcome to open a pull request to fix this issue and removed waiting for review Issue/PR is waiting for a writer's review labels Mar 8, 2022
@skedwards88
Copy link
Contributor

While you are at it can you please check the validity of the content or if there is a bug in the implementation? I had a check that was skipped due to a needs job failing and the skip counted as a pass for merging, not what it said in the document. For clarity, the needs referred to a matrix job where some of the instances failed and I could reliably replicate this bug.

@david-bain Thanks for your question! It would be best if you open a new issue for your request and included links to workflow files/logs to demonstrate your situation. https://github.community/ is probably a better place to post your question. You can then open an issue here to update the docs.

toonn added a commit to toonn/github-docs that referenced this issue Mar 10, 2022
@toonn
workflows: Add link to skipped action workaround
edafc24 
Actions that are skipped because of path filtering remain pending as
required on pull requests if they are set as required checks. Since the
required checks branch protection feature does not have a notion of
unnecessary checks a workaround is required.

This workaround is documented but hard to find so I added a note
pointing to it from the section that introduces path filtering for
workflows.

Fixes github#16048
@toonn toonn mentioned this issue Mar 10, 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 help wanted Anyone is welcome to open a pull request to fix this issue repositories Content related to repositories
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

workflows: Add link to skipped action workaround toonn/github-docs
7 participants
@toonn @janiceilene @skedwards88 @ramyaparimi @david-bain @fejalpathan and others