BranchRule class

BranchRule is the protection rule to enforce pre-defined rules on designated branches within a repository.

To get more information about BranchRule, see:

• API documentation
• How-to Guides
• Official Documentation

Example Usage

Secure Source Manager Branch Rule Basic

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const instance = new gcp.securesourcemanager.Instance("instance", {
    location: "us-central1",
    instanceId: "my-basic-instance",
    deletionPolicy: "PREVENT",
});
const repository = new gcp.securesourcemanager.Repository("repository", {
    repositoryId: "my-basic-repository",
    location: instance.location,
    instance: instance.name,
    deletionPolicy: "PREVENT",
});
const basic = new gcp.securesourcemanager.BranchRule("basic", {
    branchRuleId: "my-basic-branchrule",
    repositoryId: repository.repositoryId,
    location: repository.location,
    includePattern: "main",
});

import pulumi
import pulumi_gcp as gcp

instance = gcp.securesourcemanager.Instance("instance",
    location="us-central1",
    instance_id="my-basic-instance",
    deletion_policy="PREVENT")
repository = gcp.securesourcemanager.Repository("repository",
    repository_id="my-basic-repository",
    location=instance.location,
    instance=instance.name,
    deletion_policy="PREVENT")
basic = gcp.securesourcemanager.BranchRule("basic",
    branch_rule_id="my-basic-branchrule",
    repository_id=repository.repository_id,
    location=repository.location,
    include_pattern="main")

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() =>
{
    var instance = new Gcp.SecureSourceManager.Instance("instance", new()
    {
        Location = "us-central1",
        InstanceId = "my-basic-instance",
        DeletionPolicy = "PREVENT",
    });

    var repository = new Gcp.SecureSourceManager.Repository("repository", new()
    {
        RepositoryId = "my-basic-repository",
        Location = instance.Location,
        Instance = instance.Name,
        DeletionPolicy = "PREVENT",
    });

    var basic = new Gcp.SecureSourceManager.BranchRule("basic", new()
    {
        BranchRuleId = "my-basic-branchrule",
        RepositoryId = repository.RepositoryId,
        Location = repository.Location,
        IncludePattern = "main",
    });

});

package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/securesourcemanager"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		instance, err := securesourcemanager.NewInstance(ctx, "instance", &securesourcemanager.InstanceArgs{
			Location:       pulumi.String("us-central1"),
			InstanceId:     pulumi.String("my-basic-instance"),
			DeletionPolicy: pulumi.String("PREVENT"),
		})
		if err != nil {
			return err
		}
		repository, err := securesourcemanager.NewRepository(ctx, "repository", &securesourcemanager.RepositoryArgs{
			RepositoryId:   pulumi.String("my-basic-repository"),
			Location:       instance.Location,
			Instance:       instance.Name,
			DeletionPolicy: pulumi.String("PREVENT"),
		})
		if err != nil {
			return err
		}
		_, err = securesourcemanager.NewBranchRule(ctx, "basic", &securesourcemanager.BranchRuleArgs{
			BranchRuleId:   pulumi.String("my-basic-branchrule"),
			RepositoryId:   repository.RepositoryId,
			Location:       repository.Location,
			IncludePattern: pulumi.String("main"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

pulumi {
  required_providers {
    gcp = {
      source = "pulumi/gcp"
    }
  }
}

resource "gcp_securesourcemanager_instance" "instance" {
  location        = "us-central1"
  instance_id     = "my-basic-instance"
  deletion_policy = "PREVENT"
}
resource "gcp_securesourcemanager_repository" "repository" {
  repository_id   = "my-basic-repository"
  location        = gcp_securesourcemanager_instance.instance.location
  instance        = gcp_securesourcemanager_instance.instance.name
  deletion_policy = "PREVENT"
}
resource "gcp_securesourcemanager_branchrule" "basic" {
  branch_rule_id  = "my-basic-branchrule"
  repository_id   = gcp_securesourcemanager_repository.repository.repository_id
  location        = gcp_securesourcemanager_repository.repository.location
  include_pattern = "main"
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.securesourcemanager.Instance;
import com.pulumi.gcp.securesourcemanager.InstanceArgs;
import com.pulumi.gcp.securesourcemanager.Repository;
import com.pulumi.gcp.securesourcemanager.RepositoryArgs;
import com.pulumi.gcp.securesourcemanager.BranchRule;
import com.pulumi.gcp.securesourcemanager.BranchRuleArgs;
import java.util.ArrayList;
import java.util.Arrays;
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 instance = new Instance("instance", InstanceArgs.builder()
            .location("us-central1")
            .instanceId("my-basic-instance")
            .deletionPolicy("PREVENT")
            .build());

        var repository = new Repository("repository", RepositoryArgs.builder()
            .repositoryId("my-basic-repository")
            .location(instance.location())
            .instance(instance.name())
            .deletionPolicy("PREVENT")
            .build());

        var basic = new BranchRule("basic", BranchRuleArgs.builder()
            .branchRuleId("my-basic-branchrule")
            .repositoryId(repository.repositoryId())
            .location(repository.location())
            .includePattern("main")
            .build());

    }
}

resources:
  instance:
    type: gcp:securesourcemanager:Instance
    properties:
      location: us-central1
      instanceId: my-basic-instance
      deletionPolicy: PREVENT
  repository:
    type: gcp:securesourcemanager:Repository
    properties:
      repositoryId: my-basic-repository
      location: ${instance.location}
      instance: ${instance.name}
      deletionPolicy: PREVENT
  basic:
    type: gcp:securesourcemanager:BranchRule
    properties:
      branchRuleId: my-basic-branchrule
      repositoryId: ${repository.repositoryId}
      location: ${repository.location}
      includePattern: main

Secure Source Manager Branch Rule With Fields

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const instance = new gcp.securesourcemanager.Instance("instance", {
    location: "us-central1",
    instanceId: "my-initial-instance",
    deletionPolicy: "PREVENT",
});
const repository = new gcp.securesourcemanager.Repository("repository", {
    repositoryId: "my-initial-repository",
    instance: instance.name,
    location: instance.location,
    deletionPolicy: "PREVENT",
});
const _default = new gcp.securesourcemanager.BranchRule("default", {
    branchRuleId: "my-initial-branchrule",
    location: repository.location,
    repositoryId: repository.repositoryId,
    includePattern: "test",
    minimumApprovalsCount: 2,
    minimumReviewsCount: 2,
    requireCommentsResolved: true,
    requireLinearHistory: true,
    requirePullRequest: true,
    disabled: false,
    allowStaleReviews: false,
});

import pulumi
import pulumi_gcp as gcp

instance = gcp.securesourcemanager.Instance("instance",
    location="us-central1",
    instance_id="my-initial-instance",
    deletion_policy="PREVENT")
repository = gcp.securesourcemanager.Repository("repository",
    repository_id="my-initial-repository",
    instance=instance.name,
    location=instance.location,
    deletion_policy="PREVENT")
default = gcp.securesourcemanager.BranchRule("default",
    branch_rule_id="my-initial-branchrule",
    location=repository.location,
    repository_id=repository.repository_id,
    include_pattern="test",
    minimum_approvals_count=2,
    minimum_reviews_count=2,
    require_comments_resolved=True,
    require_linear_history=True,
    require_pull_request=True,
    disabled=False,
    allow_stale_reviews=False)

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() =>
{
    var instance = new Gcp.SecureSourceManager.Instance("instance", new()
    {
        Location = "us-central1",
        InstanceId = "my-initial-instance",
        DeletionPolicy = "PREVENT",
    });

    var repository = new Gcp.SecureSourceManager.Repository("repository", new()
    {
        RepositoryId = "my-initial-repository",
        Instance = instance.Name,
        Location = instance.Location,
        DeletionPolicy = "PREVENT",
    });

    var @default = new Gcp.SecureSourceManager.BranchRule("default", new()
    {
        BranchRuleId = "my-initial-branchrule",
        Location = repository.Location,
        RepositoryId = repository.RepositoryId,
        IncludePattern = "test",
        MinimumApprovalsCount = 2,
        MinimumReviewsCount = 2,
        RequireCommentsResolved = true,
        RequireLinearHistory = true,
        RequirePullRequest = true,
        Disabled = false,
        AllowStaleReviews = false,
    });

});

package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/securesourcemanager"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		instance, err := securesourcemanager.NewInstance(ctx, "instance", &securesourcemanager.InstanceArgs{
			Location:       pulumi.String("us-central1"),
			InstanceId:     pulumi.String("my-initial-instance"),
			DeletionPolicy: pulumi.String("PREVENT"),
		})
		if err != nil {
			return err
		}
		repository, err := securesourcemanager.NewRepository(ctx, "repository", &securesourcemanager.RepositoryArgs{
			RepositoryId:   pulumi.String("my-initial-repository"),
			Instance:       instance.Name,
			Location:       instance.Location,
			DeletionPolicy: pulumi.String("PREVENT"),
		})
		if err != nil {
			return err
		}
		_, err = securesourcemanager.NewBranchRule(ctx, "default", &securesourcemanager.BranchRuleArgs{
			BranchRuleId:            pulumi.String("my-initial-branchrule"),
			Location:                repository.Location,
			RepositoryId:            repository.RepositoryId,
			IncludePattern:          pulumi.String("test"),
			MinimumApprovalsCount:   pulumi.Int(2),
			MinimumReviewsCount:     pulumi.Int(2),
			RequireCommentsResolved: pulumi.Bool(true),
			RequireLinearHistory:    pulumi.Bool(true),
			RequirePullRequest:      pulumi.Bool(true),
			Disabled:                pulumi.Bool(false),
			AllowStaleReviews:       pulumi.Bool(false),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

pulumi {
  required_providers {
    gcp = {
      source = "pulumi/gcp"
    }
  }
}

resource "gcp_securesourcemanager_instance" "instance" {
  location        = "us-central1"
  instance_id     = "my-initial-instance"
  deletion_policy = "PREVENT"
}
resource "gcp_securesourcemanager_repository" "repository" {
  repository_id   = "my-initial-repository"
  instance        = gcp_securesourcemanager_instance.instance.name
  location        = gcp_securesourcemanager_instance.instance.location
  deletion_policy = "PREVENT"
}
resource "gcp_securesourcemanager_branchrule" "default" {
  branch_rule_id            = "my-initial-branchrule"
  location                  = gcp_securesourcemanager_repository.repository.location
  repository_id             = gcp_securesourcemanager_repository.repository.repository_id
  include_pattern           = "test"
  minimum_approvals_count   = 2
  minimum_reviews_count     = 2
  require_comments_resolved = true
  require_linear_history    = true
  require_pull_request      = true
  disabled                  = false
  allow_stale_reviews       = false
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.securesourcemanager.Instance;
import com.pulumi.gcp.securesourcemanager.InstanceArgs;
import com.pulumi.gcp.securesourcemanager.Repository;
import com.pulumi.gcp.securesourcemanager.RepositoryArgs;
import com.pulumi.gcp.securesourcemanager.BranchRule;
import com.pulumi.gcp.securesourcemanager.BranchRuleArgs;
import java.util.ArrayList;
import java.util.Arrays;
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 instance = new Instance("instance", InstanceArgs.builder()
            .location("us-central1")
            .instanceId("my-initial-instance")
            .deletionPolicy("PREVENT")
            .build());

        var repository = new Repository("repository", RepositoryArgs.builder()
            .repositoryId("my-initial-repository")
            .instance(instance.name())
            .location(instance.location())
            .deletionPolicy("PREVENT")
            .build());

        var default_ = new BranchRule("default", BranchRuleArgs.builder()
            .branchRuleId("my-initial-branchrule")
            .location(repository.location())
            .repositoryId(repository.repositoryId())
            .includePattern("test")
            .minimumApprovalsCount(2)
            .minimumReviewsCount(2)
            .requireCommentsResolved(true)
            .requireLinearHistory(true)
            .requirePullRequest(true)
            .disabled(false)
            .allowStaleReviews(false)
            .build());

    }
}

resources:
  instance:
    type: gcp:securesourcemanager:Instance
    properties:
      location: us-central1
      instanceId: my-initial-instance
      deletionPolicy: PREVENT
  repository:
    type: gcp:securesourcemanager:Repository
    properties:
      repositoryId: my-initial-repository
      instance: ${instance.name}
      location: ${instance.location}
      deletionPolicy: PREVENT
  default:
    type: gcp:securesourcemanager:BranchRule
    properties:
      branchRuleId: my-initial-branchrule
      location: ${repository.location}
      repositoryId: ${repository.repositoryId}
      includePattern: test
      minimumApprovalsCount: 2
      minimumReviewsCount: 2
      requireCommentsResolved: true
      requireLinearHistory: true
      requirePullRequest: true
      disabled: false
      allowStaleReviews: false

Import

BranchRule can be imported using any of these accepted formats:

• projects/{{project}}/locations/{{location}}/repositories/{{repository_id}}/branchRules/{{branch_rule_id}}
• {{project}}/{{location}}/{{repository_id}}/{{branch_rule_id}}
• {{location}}/{{repository_id}}/{{branch_rule_id}}
• {{branch_rule_id}}

When using the pulumi import command, BranchRule can be imported using one of the formats above. For example:

$ pulumi import gcp:securesourcemanager/branchRule:BranchRule default projects/{{project}}/locations/{{location}}/repositories/{{repository_id}}/branchRules/{{branch_rule_id}}
$ pulumi import gcp:securesourcemanager/branchRule:BranchRule default {{project}}/{{location}}/{{repository_id}}/{{branch_rule_id}}
$ pulumi import gcp:securesourcemanager/branchRule:BranchRule default {{location}}/{{repository_id}}/{{branch_rule_id}}
$ pulumi import gcp:securesourcemanager/branchRule:BranchRule default {{branch_rule_id}}

Constructors

BranchRule(String name, {BranchRuleArgs? args, CustomResourceOptions? options})

Creates a new BranchRule. name The Pulumi resource name. args Arguments used to configure this BranchRule. The set of arguments for BranchRule. options Resource options controlling this resource's behavior.

BranchRule.reference(String urn)

Creates a typed reference to an existing BranchRule resource.

Properties

allowStaleReviews ↔ Output<bool?>

Determines if allow stale reviews or approvals before merging to the branch.

late, final

branchRuleId ↔ Output<String>

The ID for the BranchRule.

late, final

childResources → Set<Resource>

final, inherited

completionSources ↔ Map<String, IOutputCompletionSource>

late, final, inherited

createTime ↔ Output<String>

Time the BranchRule was created in UTC.

late, final

deletionPolicy ↔ Output<String>

Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.

late, final

disabled ↔ Output<bool?>

Determines if the branch rule is disabled or not.

late, final

hashCode → int

The hash code for this object.

no setter, inherited

id ↔ Output<String>

getter/setter pair, inherited

includePattern ↔ Output<String>

The BranchRule matches branches based on the specified regular expression. Use .* to match all branches.

late, final

isCustom → bool

Returns whether this resource is provider-managed.

no setter, inherited

isProtected → bool

Returns whether this resource is protected from deletion.

no setter, inherited

isRemote → bool

Whether this resource is registered as remote.

no setter, inherited

isResourceReference → bool

Whether this instance represents a resource value returned over RPC.

final, inherited

location ↔ Output<String>

The location for the Repository.

late, final

minimumApprovalsCount ↔ Output<int?>

The minimum number of approvals required for the branch rule to be matched.

late, final

minimumReviewsCount ↔ Output<int?>

The minimum number of reviews required for the branch rule to be matched.

late, final

name ↔ Output<String>

The resource name for the BranchRule.

late, final

project ↔ Output<String>

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

late, final

repositoryId ↔ Output<String>

The ID for the Repository.

late, final

requireCommentsResolved ↔ Output<bool?>

Determines if require comments resolved before merging to the branch.

late, final

requireLinearHistory ↔ Output<bool?>

Determines if require linear history before merging to the branch.

late, final

requirePullRequest ↔ Output<bool?>

Determines if the branch rule requires a pull request or not.

late, final

resourceTransforms → List<ResourceTransform>

Inherited/explicit async transforms.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

transformations → List<ResourceTransformation>

Inherited/explicit legacy transformations.

no setter, inherited

uid ↔ Output<String>

Unique identifier of the BranchRule.

late, final

updateTime ↔ Output<String>

Time the BranchRule was updated in UTC.

late, final

urn ↔ Output<String>

late, final, inherited

Methods

failId(Object error) → void

Completes this resource ID with an error when registration fails.

inherited

failOutputs(Object error) → void

Completes all output properties with error.

inherited

failUrn(Object error) → void

Completes this resource URN with an error when registration fails.

inherited

getProvider(String moduleMember) → ProviderResource?

Returns provider for moduleMember's package, if configured.

inherited

getResourceName() → String

Returns this resource's logical name.

inherited

getResourceType() → String

Returns this resource's Pulumi type token.

inherited

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>

Registers a dynamic output property for this resource.

inherited

resolveId(String? value, {required bool isKnown}) → void

Resolves the provider-assigned ID for this resource.

inherited

resolveOutputs(Struct outputs) → void

Resolves all output properties from a monitor response payload.

inherited

resolveUrn(String value) → void

Resolves this resource's URN once assigned by the engine.

inherited

serializeProperties(Map<String, dynamic> properties) → Future<Struct>

Serializes resource properties for RPC transmission.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Static Methods

get(String name, Input<String> id, {BranchRuleState? state, CustomResourceOptions? options}) → BranchRule

Gets an existing BranchRule resource's state with the given name and id.