Custom properties
Custom properties allow you to decorate your repository with information such as compliance frameworks, data sensitivity, or project details.
approvalsMinimum number of approvals required for merging to protected default branch. Ignored if poc property is true or require-pull-requests is false.
1
block-force-pushSet to true to block force pushes for protected default branch. Ignored if poc property is true.
true
deny-branch-deleteSet to true to deny deletion of protected default branch. Note that GitHub should always prevent this anyway. Ignored if poc property is true.
true
dismiss-stale-approvalsSet to true to dismiss approvals when reviewable commits are pushed to PRs targeting protected default branch. Ignored if poc property is true or require-pull-requests is false.
true
enforce-codeownersSet to true to require approval from code owners before merging to protected default branch. Ignored if poc property is true, require-pull-requests is false, or the CODEOWNERS file doesn't exist.
true
enforce-squash-mergeSet to true to enforce squash as the only allowed method for merging to protected default branch. Ignored if poc property is true or require-pull-requests is false.
false
must-resolve-threadsSet to true to require conversations to be resolved before merging to protected default branch. Ignored if poc property is true or require-pull-requests is false.
true
networks-rulesetsRepo is governed by the 'Networks' rulesets instead of the org-standard ones.
false
pocProof of concept repo, set to true to bypass global branch protection rules.
false
policy-botSet to true to enforce policy-bot as a required check for merging to protected default branch. Ignored if poc property is true or require-pull-requests is false.
false
prevent-self-approvalSet to true to require approval from someone other than the person who pushed the last commit. Ignored if poc property is true or require-pull-requests is false.
true
request-copilot-reviewSet to true to automatically request review from Copilot for new pull requests if the author has access to Copilot code review. Ignored if poc property is true or require-pull-requests is false.
false
require-pull-requestsSet to true to require all commits to be submitted via a pull request before merging to protected default branch. Ignored if poc property is true.
true
sweng-commit-message-mainSet to true to enforce SWEng commit message conventions for merging to protected default branch. Ignored if poc property is true or require-pull-requests is false.
false
sweng-namingSet to true to enforce SWEng branch name and commit message conventions for all branches. Ignored if poc property is true.
false