Unable to set branch names/patterns when `custom_branch_policies` is `true`.

[Omicron7]

Affected Resource(s)

• github_repository_environment

Terraform Configuration Files

resource "github_repository_environment" "environment" {
  repository  = "repository_name"
  environment = "testing"

  deployment_branch_policy {
    protected_branches     = false
    custom_branch_policies = true
  }
}

In the GitHub console, when custom_branch_policies is set to true, it allows setting one or more Branch names/patterns to match against. It doesn't seem like this is possible in Terraform. I'm unable to find any other GitHub resource that would allow managing that list per environment. Am I missing something?

[bishwash-delphix]

I was looking for the same feature... is it possible to "Add deployment branch rule"?

[gilfthde]

Same for me. I also need to set a branch name/pattern and don't now how to do it.

[figadore]

Agree, seems like there should be a way to specify the patterns that can deploy to the environment. Maybe something like

resource "github_repository_environment" "default" {
  repository  = var.repo
  environment = "${var.env_id}"
  reviewers {
    teams = var.reviewers_team
    users = []
  }
  deployment_branch_policy {
    protected_branches          = false
    custom_branch_policies = true
    custom_branch_regex = ["main"]
  }
}

?

It doesn't look like the go-github package supports this at the moment
https://github.com/google/go-github/blob/7add3a89d10dbdcbbfab71036aa9c12e5ee997c8/github/repos_environments.go#L42

Edit: digging deeper, there isn't much else even documented for the API at https://docs.github.com/en/rest/reference/deployments#create-or-update-an-environment

Related: https://stackoverflow.com/questions/69697460/create-deployment-branch-rule-with-github-rest-api

[pasdam]

The API document specify the following:

Note: Although you can use this operation to specify that only branches that match specified name patterns can deploy to this environment, you must use the UI to set the name patterns. For more information, see "Environments."

So I guess this makes it hard to be added to the terraform module.

[StephenWithPH]

I added a comment in GitHub's product discussions to try to elevate this to their PM team: community/community#14190 (comment)

[StephenWithPH]

https://github.com/orgs/community/discussions/14190#discussioncomment-3931426 points to https://docs.github.com/en/rest/deployments/branch-policies#create-a-deployment-branch-policy, which suggests that there is now an API endpoint for this.

[kfcampbell]

If that's true, that's great news. I'd be happy to review/test/merge a PR to cover this behavior!