Repository Rules

[github-product-roadmap]

Summary

Repository rules are the evolution of GitHub's current branch protection rules, which will allow you to operate repository protections at scale with confidence and clarity.

Intended outcome

This is a new way to manage rules with a new user experience allowing for the flexible targeting of branches, rule visibility for all repository members, and for GitHub Enterprise customers, the ability to create and enforce rules at an organization level.

How will it work?

Repository rulesets

• All repository members can read all active rulesets on a repository.
• Repositories support multiple rulesets.
• Rulesets can be layered, allowing for multiple branches to have rules applied from different rulesets.
  • E.g., one ruleset for the main branch requires 2 pull request reviewers, and one ruleset for all branches requires status checks. In this case, main would require status checks and 2 pull request reviewers.
• Repository admins and authorized users can create a repository ruleset, which includes the following activities:
  • General: Name the ruleset, activate or disable the ruleset, configure who can bypass the ruleset's rules, or delete the ruleset.
  • Targeting: Select the branch(es) where rules apply. Choose from all branches, the default branch, or use wildcard matches. You can also exclude branches from matching.
  • Rules: Configure existing branch protections.

GitHub Enterprise

GitHub Enterprise accounts will have the following additional capabilities:

• Create and enforce rulesets at the organization level for all or select repositories based on pattern matching of repository names.
• Apply new rules:
  • Commit messages: Prevent commits to a branch based on commit message requirements.
  • Branch and tag names: Ensure branches and tags meet naming conventions.
  • File restrictions: Limit commits to a branch based on requirements for a file's name, path, and size.
• Set a ruleset to Evaluation mode, which allows "dry-runs" of rulesets to understand their effect before they are enforced.

[ankneis]

🚢 This has shipped: https://github.blog/changelog/2023-04-17-introducing-repository-rules-public-beta/. Leaving open to track for GHES release.

[ankneis]

This shipped with GHES 3.11: https://docs.github.com/en/enterprise-server@3.11/admin/release-notes