GitHub v5.10.0, Jun 2 23
GitHub v5.10.0, Jun 2 23
github.BranchDefault
Explore with Pulumi AI
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
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Github = Pulumi.Github;
return await Deployment.RunAsync(() =>
{
var example = new Github.Repository("example", new()
{
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/v5/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{
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()
.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());
}
}
import pulumi
import pulumi_github as github
example = github.Repository("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)
import * as pulumi from "@pulumi/pulumi";
import * as github from "@pulumi/github";
const example = new github.Repository("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,
});
resources:
example:
type: github:Repository
properties:
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
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Github = Pulumi.Github;
return await Deployment.RunAsync(() =>
{
var example = new Github.Repository("example", new()
{
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/v5/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{
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()
.description("My awesome codebase")
.autoInit(true)
.build());
var default_ = new BranchDefault("default", BranchDefaultArgs.builder()
.repository(example.name())
.branch("development")
.rename(true)
.build());
}
}
import pulumi
import pulumi_github as github
example = github.Repository("example",
description="My awesome codebase",
auto_init=True)
default = github.BranchDefault("default",
repository=example.name,
branch="development",
rename=True)
import * as pulumi from "@pulumi/pulumi";
import * as github from "@pulumi/github";
const example = new github.Repository("example", {
description: "My awesome codebase",
autoInit: true,
});
const _default = new github.BranchDefault("default", {
repository: example.name,
branch: "development",
rename: true,
});
resources:
example:
type: github:Repository
properties:
description: My awesome codebase
autoInit: true
default:
type: github:BranchDefault
properties:
repository: ${example.name}
branch: development
rename: true
Create BranchDefault Resource
new BranchDefault(name: string, args: BranchDefaultArgs, opts?: CustomResourceOptions);
@overload
def BranchDefault(resource_name: str,
opts: Optional[ResourceOptions] = None,
branch: Optional[str] = None,
rename: Optional[bool] = None,
repository: Optional[str] = None)
@overload
def BranchDefault(resource_name: str,
args: BranchDefaultArgs,
opts: Optional[ResourceOptions] = None)
func NewBranchDefault(ctx *Context, name string, args BranchDefaultArgs, opts ...ResourceOption) (*BranchDefault, error)
public BranchDefault(string name, BranchDefaultArgs args, CustomResourceOptions? opts = null)
public BranchDefault(String name, BranchDefaultArgs args)
public BranchDefault(String name, BranchDefaultArgs args, CustomResourceOptions options)
type: github:BranchDefault
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args BranchDefaultArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args BranchDefaultArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args BranchDefaultArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args BranchDefaultArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args BranchDefaultArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
BranchDefault Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The BranchDefault resource accepts the following input properties:
- Branch string
The branch (e.g.
main
)- Repository string
The GitHub repository
- Rename bool
Indicate if it should rename the branch rather than use an existing branch. Defaults to
false
.
- Branch string
The branch (e.g.
main
)- Repository string
The GitHub repository
- Rename bool
Indicate if it should rename the branch rather than use an existing branch. Defaults to
false
.
- branch String
The branch (e.g.
main
)- repository String
The GitHub repository
- rename Boolean
Indicate if it should rename the branch rather than use an existing branch. Defaults to
false
.
- branch string
The branch (e.g.
main
)- repository string
The GitHub repository
- rename boolean
Indicate if it should rename the branch rather than use an existing branch. Defaults to
false
.
- branch str
The branch (e.g.
main
)- repository str
The GitHub repository
- rename bool
Indicate if it should rename the branch rather than use an existing branch. Defaults to
false
.
- branch String
The branch (e.g.
main
)- repository String
The GitHub repository
- rename Boolean
Indicate if it should rename the branch rather than use an existing branch. Defaults to
false
.
Outputs
All input properties are implicitly available as output properties. Additionally, the BranchDefault resource produces the following output properties:
- Id string
The provider-assigned unique ID for this managed resource.
- Id string
The provider-assigned unique ID for this managed resource.
- id String
The provider-assigned unique ID for this managed resource.
- id string
The provider-assigned unique ID for this managed resource.
- id str
The provider-assigned unique ID for this managed resource.
- id String
The provider-assigned unique ID for this managed resource.
Look up Existing BranchDefault Resource
Get an existing BranchDefault resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: BranchDefaultState, opts?: CustomResourceOptions): BranchDefault
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
branch: Optional[str] = None,
rename: Optional[bool] = None,
repository: Optional[str] = None) -> BranchDefault
func GetBranchDefault(ctx *Context, name string, id IDInput, state *BranchDefaultState, opts ...ResourceOption) (*BranchDefault, error)
public static BranchDefault Get(string name, Input<string> id, BranchDefaultState? state, CustomResourceOptions? opts = null)
public static BranchDefault get(String name, Output<String> id, BranchDefaultState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Branch string
The branch (e.g.
main
)- Rename bool
Indicate if it should rename the branch rather than use an existing branch. Defaults to
false
.- Repository string
The GitHub repository
- Branch string
The branch (e.g.
main
)- Rename bool
Indicate if it should rename the branch rather than use an existing branch. Defaults to
false
.- Repository string
The GitHub repository
- branch String
The branch (e.g.
main
)- rename Boolean
Indicate if it should rename the branch rather than use an existing branch. Defaults to
false
.- repository String
The GitHub repository
- branch string
The branch (e.g.
main
)- rename boolean
Indicate if it should rename the branch rather than use an existing branch. Defaults to
false
.- repository string
The GitHub repository
- branch str
The branch (e.g.
main
)- rename bool
Indicate if it should rename the branch rather than use an existing branch. Defaults to
false
.- repository str
The GitHub repository
- branch String
The branch (e.g.
main
)- rename Boolean
Indicate if it should rename the branch rather than use an existing branch. Defaults to
false
.- repository String
The GitHub repository
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
Package Details
- Repository
- GitHub pulumi/pulumi-github
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
github
Terraform Provider.