REST API allows us to set deployment environment "selected branches", but not apply deployment rules

[krisrecur]

REST API allows us to set environment "selected branches", but not apply the all important deployment rules

API docs are not clear

https://docs.github.com/en/enterprise-cloud@latest/rest/reference/deployments#environments

After creating a deployment branch rule via the web UI, I see the following in the JSON output of the environment view operation

  "protection_rules": [
    {
      "id": 99999,
      "node_id": "XXXXXXXXXXXXXX",
      "type": "branch_policy"
    }
  ],

[ethomson]

Thanks for the feedback @krisrecur - I'll put this on the backlog for future improvements.

[matsest]

Any news on triage of this in the backlog @ethomson? Or if you can mention someone else that's involved in this backlog.

Btw, should this be labeled with API?

[StephenWithPH]

From https://docs.github.com/en/rest/deployments/environments#create-or-update-an-environment:

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.

I agree that it would be useful for the API to be extended to handle programmatically setting the branches.

This has come up here: integrations/terraform-provider-github#922 (comment)

[matsest-klp]

Is this now supported? :) - see https://docs.github.com/en/rest/deployments/branch-policies#create-a-deployment-branch-policy