Skip to content

Commit

Permalink
feat: change default to false #9120
Browse files Browse the repository at this point in the history
Having this flag as an opt-in prevents situations where a developer
working individually on a repository locks himself out from merging PRs
and pushing to the master branch without going through additional hoops.
  • Loading branch information
mhitza committed Nov 20, 2024
1 parent bf00d43 commit 8e696e4
Show file tree
Hide file tree
Showing 4 changed files with 3 additions and 4 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ your repository.
| github<br>topics `array` |-| GitHub topics. An array of strings.|
| github<br>default_branch `string` |main| Default branch configuration in GitHub (default main). Override for older repositories that still use master branch. Consider updating your repository to include a main branch and remove this option.|
| github<br>workflows<br>review `boolean` |true| The review workflow will trigger for pull requests and will check if the commit messages conform with conventional commits, and if cards are referenced as part of the commit message.|
| github<br>enforce_review_policy `boolean` |true| Enables the following GitHub branch protection rules:<ul> <li>prevent force push to default branch</li> <li>prevent deletion of default branch</li> <li>prevent PR authors from merging their own changes</li> <li>prevent reviewers from merging PRs unless all conversations are resolved and the latest changes reviewed</li> </ul>|
| github<br>enforce_review_policy `boolean` |false| Enables the following GitHub branch protection rules:<ul> <li>prevent force push to default branch</li> <li>prevent deletion of default branch</li> <li>prevent PR authors from merging their own changes</li> <li>prevent reviewers from merging PRs unless all conversations are resolved and the latest changes reviewed</li> </ul>|
| github<br>features<br>dependabot_auto_merge `boolean` |true| Generate workflow that automatically merges Dependabot PRs for patch and minor version releases.<br> *Note that merging the PR won't automatically trigger other followup workflows.*|
| github<br>features<br>downloads `boolean` |true| Enable repository downloads.|
| github<br>features<br>squash_merge `boolean` |true| Allow squash-merging pull requests.|
Expand Down
2 changes: 1 addition & 1 deletion docs/partials/readme.configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
| github<br>topics `array` |-| GitHub topics. An array of strings.|
| github<br>default_branch `string` |main| Default branch configuration in GitHub (default main). Override for older repositories that still use master branch. Consider updating your repository to include a main branch and remove this option.|
| github<br>workflows<br>review `boolean` |true| The review workflow will trigger for pull requests and will check if the commit messages conform with conventional commits, and if cards are referenced as part of the commit message.|
| github<br>enforce_review_policy `boolean` |true| Enables the following GitHub branch protection rules:<ul> <li>prevent force push to default branch</li> <li>prevent deletion of default branch</li> <li>prevent PR authors from merging their own changes</li> <li>prevent reviewers from merging PRs unless all conversations are resolved and the latest changes reviewed</li> </ul>|
| github<br>enforce_review_policy `boolean` |false| Enables the following GitHub branch protection rules:<ul> <li>prevent force push to default branch</li> <li>prevent deletion of default branch</li> <li>prevent PR authors from merging their own changes</li> <li>prevent reviewers from merging PRs unless all conversations are resolved and the latest changes reviewed</li> </ul>|
| github<br>features<br>dependabot_auto_merge `boolean` |true| Generate workflow that automatically merges Dependabot PRs for patch and minor version releases.<br> *Note that merging the PR won't automatically trigger other followup workflows.*|
| github<br>features<br>downloads `boolean` |true| Enable repository downloads.|
| github<br>features<br>squash_merge `boolean` |true| Allow squash-merging pull requests.|
Expand Down
2 changes: 1 addition & 1 deletion repo.schema.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,7 @@ properties:
enforce_review_policy:
type: boolean
default: true
default: false
description: >
Enables the following GitHub branch protection rules:<ul>
<li>prevent force push to default branch</li>
Expand Down
1 change: 0 additions & 1 deletion repo.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@ github:
topics:
- ansible
- automation
enforce_review_policy: false
features:
wiki: true
issues: true
Expand Down

0 comments on commit 8e696e4

Please sign in to comment.