RepositoryDeploymentBranchPolicy

class RepositoryDeploymentBranchPolicy : KotlinCustomResource

This resource allows you to create and manage deployment branch policies.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as github from "@pulumi/github";
const env = new github.RepositoryEnvironment("env", {
repository: "my_repo",
environment: "my_env",
deploymentBranchPolicy: {
protectedBranches: false,
customBranchPolicies: true,
},
});
const foo = new github.RepositoryDeploymentBranchPolicy("foo", {
repository: "my_repo",
environmentName: "my_env",
name: "foo",
}, {
dependsOn: [env],
});
import pulumi
import pulumi_github as github
env = github.RepositoryEnvironment("env",
repository="my_repo",
environment="my_env",
deployment_branch_policy={
"protected_branches": False,
"custom_branch_policies": True,
})
foo = github.RepositoryDeploymentBranchPolicy("foo",
repository="my_repo",
environment_name="my_env",
name="foo",
opts = pulumi.ResourceOptions(depends_on=[env]))
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Github = Pulumi.Github;
return await Deployment.RunAsync(() =>
{
var env = new Github.RepositoryEnvironment("env", new()
{
Repository = "my_repo",
Environment = "my_env",
DeploymentBranchPolicy = new Github.Inputs.RepositoryEnvironmentDeploymentBranchPolicyArgs
{
ProtectedBranches = false,
CustomBranchPolicies = true,
},
});
var foo = new Github.RepositoryDeploymentBranchPolicy("foo", new()
{
Repository = "my_repo",
EnvironmentName = "my_env",
Name = "foo",
}, new CustomResourceOptions
{
DependsOn =
{
env,
},
});
});
package main
import (
"github.com/pulumi/pulumi-github/sdk/v6/go/github"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
env, err := github.NewRepositoryEnvironment(ctx, "env", &github.RepositoryEnvironmentArgs{
Repository: pulumi.String("my_repo"),
Environment: pulumi.String("my_env"),
DeploymentBranchPolicy: &github.RepositoryEnvironmentDeploymentBranchPolicyArgs{
ProtectedBranches: pulumi.Bool(false),
CustomBranchPolicies: pulumi.Bool(true),
},
})
if err != nil {
return err
}
_, err = github.NewRepositoryDeploymentBranchPolicy(ctx, "foo", &github.RepositoryDeploymentBranchPolicyArgs{
Repository: pulumi.String("my_repo"),
EnvironmentName: pulumi.String("my_env"),
Name: pulumi.String("foo"),
}, pulumi.DependsOn([]pulumi.Resource{
env,
}))
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.github.RepositoryEnvironment;
import com.pulumi.github.RepositoryEnvironmentArgs;
import com.pulumi.github.inputs.RepositoryEnvironmentDeploymentBranchPolicyArgs;
import com.pulumi.github.RepositoryDeploymentBranchPolicy;
import com.pulumi.github.RepositoryDeploymentBranchPolicyArgs;
import com.pulumi.resources.CustomResourceOptions;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var env = new RepositoryEnvironment("env", RepositoryEnvironmentArgs.builder()
.repository("my_repo")
.environment("my_env")
.deploymentBranchPolicy(RepositoryEnvironmentDeploymentBranchPolicyArgs.builder()
.protectedBranches(false)
.customBranchPolicies(true)
.build())
.build());
var foo = new RepositoryDeploymentBranchPolicy("foo", RepositoryDeploymentBranchPolicyArgs.builder()
.repository("my_repo")
.environmentName("my_env")
.name("foo")
.build(), CustomResourceOptions.builder()
.dependsOn(env)
.build());
}
}
resources:
env:
type: github:RepositoryEnvironment
properties:
repository: my_repo
environment: my_env
deploymentBranchPolicy:
protectedBranches: false
customBranchPolicies: true
foo:
type: github:RepositoryDeploymentBranchPolicy
properties:
repository: my_repo
environmentName: my_env
name: foo
options:
dependsOn:
- ${env}

Import

$ pulumi import github:index/repositoryDeploymentBranchPolicy:RepositoryDeploymentBranchPolicy foo repo:env:id

Properties

Link copied to clipboard
val environmentName: Output<String>

The name of the environment. This environment must have deployment_branch_policy.custom_branch_policies set to true or a 404 error will be thrown.

Link copied to clipboard
val etag: Output<String>

An etag representing the Branch object.

Link copied to clipboard
val id: Output<String>
Link copied to clipboard
val name: Output<String>

The name pattern that branches must match in order to deploy to the environment.

Link copied to clipboard
val pulumiChildResources: Set<KotlinResource>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
val repository: Output<String>

The repository to create the policy in.

Link copied to clipboard
val urn: Output<String>