Docs updates for ignore checks rule update. (#51825)
Co-authored-by: Joe Clark <31087804+jc-clark@users.noreply.github.com> Co-authored-by: jc-clark <jc-clark@github.com>
This commit is contained in:
@@ -136,7 +136,7 @@ Required status checks ensure that all required CI tests are passing before coll
|
||||
|
||||
You can use the commit status API to allow external services to mark commits with an appropriate status. For more information, see "[AUTOTITLE](/rest/commits/statuses)."
|
||||
|
||||
After enabling required status checks, all required status checks must pass before collaborators can merge changes into the branch or tag.
|
||||
After enabling required status checks, all required status checks must pass before collaborators can merge changes into the branch or tag. {% ifversion repo-rules-ignorecheck %} Optionally, you can select "Do not require status checks on creation" if you wish to allow branch creation regardless of the status check result. {% endif %}
|
||||
|
||||
Any person or integration with write permissions to a repository can set the state of any status check in the repository, but in some cases you may only want to accept a status check from a specific {% data variables.product.prodname_github_app %}. When you add a required status check rule, you can select an app as the expected source of status updates. The app must be installed in the repository with the `statuses:write` permission, must have recently submitted a check run, and must be associated with a pre-existing required status check in the ruleset. If the status is set by any other person or integration, merging won't be allowed. If you select "any source", you can still manually verify the author of each status, listed in the merge box.
|
||||
|
||||
@@ -214,6 +214,7 @@ Applying this rule will block direct pushes because the ruleset workflows run as
|
||||
|
||||
This rule should only be added to rulesets that target branches where all changes to the branch are performed by pull requests.
|
||||
|
||||
{% ifversion repo-rules-ignorecheck %} Optionally, you can select "Do not require workflows checks on creation" if you wish to allow branch creation regardless of the status check result. {% endif %}
|
||||
{% endif %}
|
||||
|
||||
{% ifversion repo-rules-enterprise %}
|
||||
|
||||
6
data/features/repo-rules-ignorecheck.yml
Normal file
6
data/features/repo-rules-ignorecheck.yml
Normal file
@@ -0,0 +1,6 @@
|
||||
# Reference: #15296
|
||||
# Docs for the ruleset update to allow skipping enforcement of status checks and workflows on new branches.
|
||||
|
||||
versions:
|
||||
ghec: '*'
|
||||
ghes: '>=3.15'
|
||||
Reference in New Issue
Block a user