GitHub

Pulumi Official
Package maintained by Pulumi
v4.11.0 published on Wednesday, Apr 6, 2022 by Pulumi

getBranch

Use this data source to retrieve information about a repository branch.

Example Usage

using Pulumi;
using Github = Pulumi.Github;

class MyStack : Stack
{
    public MyStack()
    {
        var development = Output.Create(Github.GetBranch.InvokeAsync(new Github.GetBranchArgs
        {
            Branch = "development",
            Repository = "example",
        }));
    }

}
package main

import (
	"github.com/pulumi/pulumi-github/sdk/v4/go/github"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := github.LookupBranch(ctx, &GetBranchArgs{
			Branch:     "development",
			Repository: "example",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

Coming soon!

import pulumi
import pulumi_github as github

development = github.get_branch(branch="development",
    repository="example")
import * as pulumi from "@pulumi/pulumi";
import * as github from "@pulumi/github";

const development = pulumi.output(github.getBranch({
    branch: "development",
    repository: "example",
}));

Coming soon!

Using getBranch

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getBranch(args: GetBranchArgs, opts?: InvokeOptions): Promise<GetBranchResult>
function getBranchOutput(args: GetBranchOutputArgs, opts?: InvokeOptions): Output<GetBranchResult>
def get_branch(branch: Optional[str] = None,
               repository: Optional[str] = None,
               opts: Optional[InvokeOptions] = None) -> GetBranchResult
def get_branch_output(branch: Optional[pulumi.Input[str]] = None,
               repository: Optional[pulumi.Input[str]] = None,
               opts: Optional[InvokeOptions] = None) -> Output[GetBranchResult]
func LookupBranch(ctx *Context, args *LookupBranchArgs, opts ...InvokeOption) (*LookupBranchResult, error)
func LookupBranchOutput(ctx *Context, args *LookupBranchOutputArgs, opts ...InvokeOption) LookupBranchResultOutput

> Note: This function is named LookupBranch in the Go SDK.

public static class GetBranch 
{
    public static Task<GetBranchResult> InvokeAsync(GetBranchArgs args, InvokeOptions? opts = null)
    public static Output<GetBranchResult> Invoke(GetBranchInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetBranchResult> getBranch(GetBranchArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
  Function: github:index/getBranch:getBranch
  Arguments:
    # Arguments dictionary

The following arguments are supported:

Branch string

The repository branch to create.

Repository string

The GitHub repository name.

Branch string

The repository branch to create.

Repository string

The GitHub repository name.

branch String

The repository branch to create.

repository String

The GitHub repository name.

branch string

The repository branch to create.

repository string

The GitHub repository name.

branch str

The repository branch to create.

repository str

The GitHub repository name.

branch String

The repository branch to create.

repository String

The GitHub repository name.

getBranch Result

The following output properties are available:

Branch string
Etag string

An etag representing the Branch object.

Id string

The provider-assigned unique ID for this managed resource.

Ref string

A string representing a branch reference, in the form of refs/heads/<branch>.

Repository string
Sha string

A string storing the reference's HEAD commit's SHA1.

Branch string
Etag string

An etag representing the Branch object.

Id string

The provider-assigned unique ID for this managed resource.

Ref string

A string representing a branch reference, in the form of refs/heads/<branch>.

Repository string
Sha string

A string storing the reference's HEAD commit's SHA1.

branch String
etag String

An etag representing the Branch object.

id String

The provider-assigned unique ID for this managed resource.

ref String

A string representing a branch reference, in the form of refs/heads/<branch>.

repository String
sha String

A string storing the reference's HEAD commit's SHA1.

branch string
etag string

An etag representing the Branch object.

id string

The provider-assigned unique ID for this managed resource.

ref string

A string representing a branch reference, in the form of refs/heads/<branch>.

repository string
sha string

A string storing the reference's HEAD commit's SHA1.

branch str
etag str

An etag representing the Branch object.

id str

The provider-assigned unique ID for this managed resource.

ref str

A string representing a branch reference, in the form of refs/heads/<branch>.

repository str
sha str

A string storing the reference's HEAD commit's SHA1.

branch String
etag String

An etag representing the Branch object.

id String

The provider-assigned unique ID for this managed resource.

ref String

A string representing a branch reference, in the form of refs/heads/<branch>.

repository String
sha String

A string storing the reference's HEAD commit's SHA1.

Package Details

Repository
https://github.com/pulumi/pulumi-github
License
Apache-2.0
Notes

This Pulumi package is based on the github Terraform Provider.