pulumi-gitlab-kotlin/com.pulumi.gitlab.kotlin/Branch

Branch

class Branch : KotlinCustomResource

The gitlab.Branch resource allows to manage the lifecycle of a repository branch. Upstream API: GitLab REST API docs

Example Usage

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gitlab.Project;
import com.pulumi.gitlab.ProjectArgs;
import com.pulumi.gitlab.Branch;
import com.pulumi.gitlab.BranchArgs;
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 exampleProject = new Project("exampleProject", ProjectArgs.builder()
            .description("An example project")
            .namespaceId(gitlab_group.example().id())
            .build());
        var exampleBranch = new Branch("exampleBranch", BranchArgs.builder()
            .ref("main")
            .project(exampleProject.id())
            .build());
    }
}
Content copied to clipboard

Import

Gitlab protected branches can be imported with a key composed of <project_id>:<branch_name>, e.g.

$ pulumi import gitlab:index/branch:Branch example "12345:develop"
Content copied to clipboard

Properties

Link copied to clipboard
val canPush: Output<Boolean>

Bool, true if you can push to the branch.

Link copied to clipboard
val commits: Output<List<BranchCommit>>

The commit associated with the branch ref.

Link copied to clipboard
val default: Output<Boolean>

Bool, true if branch is the default branch for the project.

Link copied to clipboard
val developerCanMerge: Output<Boolean>

Bool, true if developer level access allows to merge branch.

Link copied to clipboard
val developerCanPush: Output<Boolean>

Bool, true if developer level access allows git push.

Link copied to clipboard
val id: Output<String>
Link copied to clipboard
val merged: Output<Boolean>

Bool, true if the branch has been merged into it's parent.

Link copied to clipboard
val name: Output<String>

The name for this branch.

Link copied to clipboard
val project: Output<String>

The ID or full path of the project which the branch is created against.

Link copied to clipboard
val protected: Output<Boolean>

Bool, true if branch has branch protection.

Link copied to clipboard
val pulumiChildResources: Set<KotlinResource>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
val ref: Output<String>

The ref which the branch is created from.

Link copied to clipboard
val urn: Output<String>
Link copied to clipboard
val webUrl: Output<String>

The url of the created branch (https).