Enforce Default Branch Name for GitHub Repositories

Enforcing a default branch name for GitHub repositories ensures consistency, improves collaboration, and aligns with organizational standards. This practice helps maintain clarity across projects and simplifies workflows, enhancing overall repository management.

This policy pack can help you configure the following settings for GitHub repositories:

Enforce a default branch name

Documentation

Review policy settings →

Getting Started

Requirements

Terraform
Guardrails mods:
- @turbot/github

Credentials

To create a policy pack through Terraform:

Ensure you have Turbot/Admin permissions (or higher) in Guardrails
Create access keys in Guardrails

And then set your credentials:

export TURBOT_WORKSPACE=myworkspace.acme.com
export TURBOT_ACCESS_KEY=acce6ac5-access-key-here
export TURBOT_SECRET_KEY=a8af61ec-secret-key-here

Please see Turbot Guardrails Provider authentication for additional authentication methods.

Usage

Install Policy Pack

Note
By default, installed policy packs are not attached to any resources.

Policy packs must be attached to resources in order for their policy settings to take effect.

Clone:

git clone https://github.com/turbot/guardrails-samples.git
cd guardrails-samples/policy_packs/github/enforce_default_branch_name_for_repositories

Run the Terraform to create the policy pack in your workspace:

terraform init
terraform plan

Then apply the changes:

terraform apply

Apply Policy Pack

Log into your Guardrails workspace and attach the policy pack to a resource.

If this policy pack is attached to a Guardrails folder, its policies will be applied to all accounts and resources in that folder. The policy pack can also be attached to multiple resources.

For more information, please see Policy Packs.

Enable Enforcement

Tip
You can also update the policy settings in this policy pack directly in the Guardrails console.

Please note your Terraform state file will then become out of sync and the policy settings should then only be managed in the console.

By default, the policies are set to Check in the pack's policy settings. To enable automated enforcements, you can switch these policies settings by adding a comment to the Check setting and removing the comment from one of the listed enforcement options:

resource "turbot_policy_setting" "github_repository_default_branch" {
  resource = turbot_policy_pack.main.id
  type     = "tmod:@turbot/github#/policy/types/repositoryDefaultBranch"
  # value    = "Check: Set to `Default Branch > Name`"
  value    = "Enforce: Set to `Default Branch > Name`"
}

Then re-apply the changes:

terraform plan
terraform apply