getRepositoryBranches

Use this data source to retrieve information about branches in a repository.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as github from "@pulumi/github";
const example = github.getRepositoryBranches({
repository: "example-repository",
});
import pulumi
import pulumi_github as github
example = github.get_repository_branches(repository="example-repository")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Github = Pulumi.Github;
return await Deployment.RunAsync(() =>
{
var example = Github.GetRepositoryBranches.Invoke(new()
{
Repository = "example-repository",
});
});
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 {
_, err := github.GetRepositoryBranches(ctx, &github.GetRepositoryBranchesArgs{
Repository: "example-repository",
}, nil)
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.GithubFunctions;
import com.pulumi.github.inputs.GetRepositoryBranchesArgs;
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) {
final var example = GithubFunctions.getRepositoryBranches(GetRepositoryBranchesArgs.builder()
.repository("example-repository")
.build());
}
}
variables:
example:
fn::invoke:
function: github:getRepositoryBranches
arguments:
repository: example-repository

Return

A collection of values returned by getRepositoryBranches.

Parameters

argument

A collection of arguments for invoking getRepositoryBranches.


suspend fun getRepositoryBranches(onlyNonProtectedBranches: Boolean? = null, onlyProtectedBranches: Boolean? = null, repository: String): GetRepositoryBranchesResult

Return

A collection of values returned by getRepositoryBranches.

Parameters

onlyNonProtectedBranches

. If true, the branches attributes will be populated only with non protected branches. Default: false.

onlyProtectedBranches

. If true, the branches attributes will be populated only with protected branches. Default: false.

repository

Name of the repository to retrieve the branches from.

See also


Return

A collection of values returned by getRepositoryBranches.

Parameters

argument

Builder for com.pulumi.github.kotlin.inputs.GetRepositoryBranchesPlainArgs.

See also