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.

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

workflows: Add link to skipped action workaround #16173

Merged
merged 3 commits into from
Apr 4, 2022

Conversation

toonn
Copy link
Contributor

@toonn toonn commented Mar 10, 2022

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 #16048

Why:

Closes issue link

What's being changed:

Check off the following:

  • I have reviewed my changes in staging (look for "Automatically generated comment" and click Modified to view your latest changes).
  • For content changes, I have completed the self-review checklist.

Writer impact (This section is for GitHub staff members only):

  • This pull request impacts the contribution experience
    • I have added the 'writer impact' label
    • I have added a description and/or a video demo of the changes below (e.g. a "before and after video")

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
@welcome
Copy link

welcome bot commented Mar 10, 2022

Thanks for opening this pull request! 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 10, 2022
@toonn
Copy link
Contributor Author

toonn commented Mar 10, 2022

How long do I need to wait for the "Automatically generated comment"? Does it not get generated for draft PRs?

@ramyaparimi
Copy link
Contributor

@toonn Ah, that's a great catch. I didn't know the PR has to be "ready for review" for the auto generated comment. I will add that clarity in the PR template.

You can view your changes by clicking the "show environments" and "view deployment" button on the PR feed when the PR is in draft mode.
image

@toonn toonn marked this pull request as ready for review March 11, 2022 22:38
@github-actions
Copy link
Contributor

A stale label has been added to this pull request because it has been open 7 days with no activity. To keep this PR open, add a comment or push a commit within 3 days.

@github-actions github-actions bot added the stale There is no recent activity on this issue or pull request label Mar 20, 2022
@toonn
Copy link
Contributor Author

toonn commented Mar 20, 2022

I think my side of this is fulfilled, waiting for a reaction.

@ramyaparimi
Copy link
Contributor

@toonn Thanks for the comment. Could you please leave a comment next time when you convert your draft PR to ready for review? That way I will get notified and get this triaged 💖.

Thank you for opening this PR, I will get this triaged for a review ✨

@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 content This issue or pull request belongs to the Docs Content team needs SME This proposal needs review from a subject matter expert and removed triage Do not begin working on this issue until triaged by the team stale There is no recent activity on this issue or pull request labels Mar 21, 2022
Copy link
Contributor

@lucascosti lucascosti left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks a lot for this addition, @toonn! It will make that info easier to find. I've made a few edits, and will merge this in.

@lucascosti lucascosti enabled auto-merge (squash) April 4, 2022 06:51
@lucascosti lucascosti merged commit 911d209 into github:main Apr 4, 2022
@github-actions
Copy link
Contributor

github-actions bot commented Apr 4, 2022

Thanks very much for contributing! Your pull request has been merged 🎉 You should see your changes appear on the site in approximately 24 hours. If you're looking for your next contribution, check out our help wanted issues

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
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 needs SME This proposal needs review from a subject matter expert waiting for review Issue/PR is waiting for a writer's review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Provide more visibility for the article on skipped but required checks
3 participants