Skip to content

Commit

Permalink
chore: clarify that embedded settings of a Ruleset can be null
Browse files Browse the repository at this point in the history
  • Loading branch information
@netomi
netomi committed Oct 16, 2024
1 parent f5b0225 commit 3e68a6c
Showing 1 changed file with 19 additions and 19 deletions.
38 changes: 19 additions & 19 deletions docs/reference/organization/repository/ruleset.md
View file
Original file line number Diff line number Diff line change
@@ -1,24 +1,24 @@
Definition of a `Repository Ruleset`, the following properties are supported:

| Key | Value | Description | Notes |
|------------------------------------|-----------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------|
| _name_ | string | The name of this repository ruleset | |
| _target_ | string | The target of this ruleset | Possible values are `branch`, `tag` or `push` |
| _enforcement_ | string | The enforcement status of this ruleset | Possible values are `active`, `disabled` or `evaluate` (`evaluate` only available when enterprise billing is enabled) |
| _bypass_actors_ | list\[[BypassActor](bypass-actor.md)\] | List of actors able to bypass this ruleset | |
| _include_refs_ | list\[[RefMatcher](ref-matcher.md)\] | List of refs or patterns to include matching branches | |
| _exclude_refs_ | list\[[RefMatcher](ref-matcher.md)\] | List of refs or patterns to exclude matching branches | |
| _allows_creations_ | boolean | If disabled, only allows users with bypass permission to create matching refs | |
| _allows_deletions_ | boolean | If disabled, only allows users with bypass permission to delete matching refs | |
| _allows_updates_ | boolean | If disabled, only allows users with bypass permission to push matching refs | |
| _allows_force_pushes_ | boolean | If disabled, only allows users with bypass permission to force push matching refs | |
| _required_status_checks_ | [StatusCheckSettings](#status-check-settings) | If enabled, status checks must pass before branches can be merged into a matching branch | |
| _requires_commit_signatures_ | boolean | If enabled, commits pushed to matching branches must have verified signatures | |
| _requires_linear_history_ | boolean | If enabled, prevent merge commits from being pushed to matching branches | |
| _requires_deployments_ | boolean | If enabled, environments must be successfully deployed to before branches can be merged into a matching branch | |
| _required_deployment_environments_ | list[string] | List of environments that must be successfully deployed to before branches can be merged | Only taken into account when `requires_deployments` is enabled |
| _required_pull_request_ | [PullRequestSettings](#pull-request-settings) | If specified, requires a pull request before merging. All commits must be made to a non-protected branch and submitted via a pull request before they can be merged into matching branches | |
| _required_merge_queue_ | [MergeQueueSettings](#merge-queue-settings) | If specified, merges must be performed via a merge queue | |
| Key | Value | Description | Notes |
|------------------------------------|-------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------|
| _name_ | string | The name of this repository ruleset | |
| _target_ | string | The target of this ruleset | Possible values are `branch`, `tag` or `push` |
| _enforcement_ | string | The enforcement status of this ruleset | Possible values are `active`, `disabled` or `evaluate` (`evaluate` only available when enterprise billing is enabled) |
| _bypass_actors_ | list\[[BypassActor](bypass-actor.md)\] | List of actors able to bypass this ruleset | |
| _include_refs_ | list\[[RefMatcher](ref-matcher.md)\] | List of refs or patterns to include matching branches | |
| _exclude_refs_ | list\[[RefMatcher](ref-matcher.md)\] | List of refs or patterns to exclude matching branches | |
| _allows_creations_ | boolean | If disabled, only allows users with bypass permission to create matching refs | |
| _allows_deletions_ | boolean | If disabled, only allows users with bypass permission to delete matching refs | |
| _allows_updates_ | boolean | If disabled, only allows users with bypass permission to push matching refs | |
| _allows_force_pushes_ | boolean | If disabled, only allows users with bypass permission to force push matching refs | |
| _required_status_checks_ | [StatusCheckSettings](#status-check-settings) or null | If specified, status checks must pass before branches can be merged into a matching branch | |
| _requires_commit_signatures_ | boolean | If enabled, commits pushed to matching branches must have verified signatures | |
| _requires_linear_history_ | boolean | If enabled, prevent merge commits from being pushed to matching branches | |
| _requires_deployments_ | boolean | If enabled, environments must be successfully deployed to before branches can be merged into a matching branch | |
| _required_deployment_environments_ | list[string] | List of environments that must be successfully deployed to before branches can be merged | Only taken into account when `requires_deployments` is enabled |
| _required_pull_request_ | [PullRequestSettings](#pull-request-settings) or null | If specified, requires a pull request before merging. All commits must be made to a non-protected branch and submitted via a pull request before they can be merged into matching branches | |
| _required_merge_queue_ | [MergeQueueSettings](#merge-queue-settings) or null | If specified, merges must be performed via a merge queue | |

Rulesets can be used for use-cases (e.g. to support auto merging of pull requests) that can not be modelled with Branch Protection Rules:

Expand Down

0 comments on commit 3e68a6c

Please sign in to comment.