pulumi-github-kotlin/com.pulumi.github.kotlin/BranchDefaultArgs

BranchDefaultArgs

data class BranchDefaultArgs(val branch: Output<String>? = null, val rename: Output<Boolean>? = null, val repository: Output<String>? = null) : ConvertibleToJava<BranchDefaultArgs>

Provides a GitHub branch default resource. This resource allows you to set the default branch for a given repository. Note that use of this resource is incompatible with the default_branch option of the github.Repository resource. Using both will result in plans always showing a diff.

Example Usage

Basic usage:

import * as pulumi from "@pulumi/pulumi";
import * as github from "@pulumi/github";
const example = new github.Repository("example", {
    name: "example",
    description: "My awesome codebase",
    autoInit: true,
});
const development = new github.Branch("development", {
    repository: example.name,
    branch: "development",
});
const _default = new github.BranchDefault("default", {
    repository: example.name,
    branch: development.branch,
});

import pulumi
import pulumi_github as github
example = github.Repository("example",
    name="example",
    description="My awesome codebase",
    auto_init=True)
development = github.Branch("development",
    repository=example.name,
    branch="development")
default = github.BranchDefault("default",
    repository=example.name,
    branch=development.branch)

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Github = Pulumi.Github;
return await Deployment.RunAsync(() =>
{
    var example = new Github.Repository("example", new()
    {
        Name = "example",
        Description = "My awesome codebase",
        AutoInit = true,
    });
    var development = new Github.Branch("development", new()
    {
        Repository = example.Name,
        BranchName = "development",
    });
    var @default = new Github.BranchDefault("default", new()
    {
        Repository = example.Name,
        Branch = development.BranchName,
    });
});

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 {
		example, err := github.NewRepository(ctx, "example", &github.RepositoryArgs{
			Name:        pulumi.String("example"),
			Description: pulumi.String("My awesome codebase"),
			AutoInit:    pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		development, err := github.NewBranch(ctx, "development", &github.BranchArgs{
			Repository: example.Name,
			Branch:     pulumi.String("development"),
		})
		if err != nil {
			return err
		}
		_, err = github.NewBranchDefault(ctx, "default", &github.BranchDefaultArgs{
			Repository: example.Name,
			Branch:     development.Branch,
		})
		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.Repository;
import com.pulumi.github.RepositoryArgs;
import com.pulumi.github.Branch;
import com.pulumi.github.BranchArgs;
import com.pulumi.github.BranchDefault;
import com.pulumi.github.BranchDefaultArgs;
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 example = new Repository("example", RepositoryArgs.builder()
            .name("example")
            .description("My awesome codebase")
            .autoInit(true)
            .build());
        var development = new Branch("development", BranchArgs.builder()
            .repository(example.name())
            .branch("development")
            .build());
        var default_ = new BranchDefault("default", BranchDefaultArgs.builder()
            .repository(example.name())
            .branch(development.branch())
            .build());
    }
}

resources:
  example:
    type: github:Repository
    properties:
      name: example
      description: My awesome codebase
      autoInit: true
  development:
    type: github:Branch
    properties:
      repository: ${example.name}
      branch: development
  default:
    type: github:BranchDefault
    properties:
      repository: ${example.name}
      branch: ${development.branch}

Renaming to a branch that doesn't exist:

import * as pulumi from "@pulumi/pulumi";
import * as github from "@pulumi/github";
const example = new github.Repository("example", {
    name: "example",
    description: "My awesome codebase",
    autoInit: true,
});
const _default = new github.BranchDefault("default", {
    repository: example.name,
    branch: "development",
    rename: true,
});

import pulumi
import pulumi_github as github
example = github.Repository("example",
    name="example",
    description="My awesome codebase",
    auto_init=True)
default = github.BranchDefault("default",
    repository=example.name,
    branch="development",
    rename=True)

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Github = Pulumi.Github;
return await Deployment.RunAsync(() =>
{
    var example = new Github.Repository("example", new()
    {
        Name = "example",
        Description = "My awesome codebase",
        AutoInit = true,
    });
    var @default = new Github.BranchDefault("default", new()
    {
        Repository = example.Name,
        Branch = "development",
        Rename = true,
    });
});

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 {
		example, err := github.NewRepository(ctx, "example", &github.RepositoryArgs{
			Name:        pulumi.String("example"),
			Description: pulumi.String("My awesome codebase"),
			AutoInit:    pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		_, err = github.NewBranchDefault(ctx, "default", &github.BranchDefaultArgs{
			Repository: example.Name,
			Branch:     pulumi.String("development"),
			Rename:     pulumi.Bool(true),
		})
		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.Repository;
import com.pulumi.github.RepositoryArgs;
import com.pulumi.github.BranchDefault;
import com.pulumi.github.BranchDefaultArgs;
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 example = new Repository("example", RepositoryArgs.builder()
            .name("example")
            .description("My awesome codebase")
            .autoInit(true)
            .build());
        var default_ = new BranchDefault("default", BranchDefaultArgs.builder()
            .repository(example.name())
            .branch("development")
            .rename(true)
            .build());
    }
}

resources:
  example:
    type: github:Repository
    properties:
      name: example
      description: My awesome codebase
      autoInit: true
  default:
    type: github:BranchDefault
    properties:
      repository: ${example.name}
      branch: development
      rename: true

Import

GitHub Branch Defaults can be imported using an ID made up of repository, e.g.

$ pulumi import github:index/branchDefault:BranchDefault branch_default my-repo

Constructors

BranchDefaultArgs

constructor(branch: Output<String>? = null, rename: Output<Boolean>? = null, repository: Output<String>? = null)

Properties

branch

val branch: Output<String>? = null

The branch (e.g. main)

rename

val rename: Output<Boolean>? = null

Indicate if it should rename the branch rather than use an existing branch. Defaults to false.

repository

val repository: Output<String>? = null

The GitHub repository

Functions

toJava

open override fun toJava(): BranchDefaultArgs