provider repos PUT /repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies/{branch_policy_id}
@utdk/github /repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies/{branch_policy_id}
Update a deployment branch policy
Updates a deployment branch or tag policy for an environment. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
owner path required
The account owner of the repository. The name is not case sensitive.
string
repo path required
The name of the repository without the `.git` extension. The name is not case sensitive.
string
environment_name path required
The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`.
string
branch_policy_id path required
The unique identifier of the branch policy.
integer

Try it

Authentication
Configure credentials for GitHub v3 REST API
Gateway
The gateway proxies requests and injects credentials server-side. Configure credentials above, then enter your gateway URL.

Saved automatically to browser storage.

repos.updateDeploymentBranchPolicy
PUT/repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies/{branch_policy_id}
Updates a deployment branch or tag policy for an environment. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.

Parameters

required

The account owner of the repository. The name is not case sensitive.

required

The name of the repository without the `.git` extension. The name is not case sensitive.

required

The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`.

required

The unique identifier of the branch policy.

Input

required

The name pattern that branches must match in order to deploy to the environment. Wildcard characters will not match `/`. For example, to match branches that begin with `release/` and contain an additional single slash, use `release/*/*`. For more information about pattern matching syntax, see the [Ruby File.fnmatch documentation](https://ruby-doc.org/core-2.5.1/File.html#method-c-fnmatch).

Enter a gateway URL above to enable sending.

Code snippet
Updates live as you fill in the form above.

TypeScript

import github from '@utdk/github';

await github.repos.updateDeploymentBranchPolicy()