getTree

suspend fun getTree(argument: GetTreePlainArgs): GetTreeResult

Use this data source to retrieve information about a single tree.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as github from "@pulumi/github";
const _this = github.getRepository({
name: "example",
});
const thisGetBranch = Promise.all([_this, _this]).then(([_this, _this1]) => github.getBranch({
branch: _this.defaultBranch,
repository: _this1.name,
}));
const thisGetTree = Promise.all([_this, thisGetBranch]).then(([_this, thisGetBranch]) => github.getTree({
recursive: false,
repository: _this.name,
treeSha: thisGetBranch.sha,
}));
export const entries = thisGetTree.then(thisGetTree => thisGetTree.entries);
import pulumi
import pulumi_github as github
this = github.get_repository(name="example")
this_get_branch = github.get_branch(branch=this.default_branch,
repository=this.name)
this_get_tree = github.get_tree(recursive=False,
repository=this.name,
tree_sha=this_get_branch.sha)
pulumi.export("entries", this_get_tree.entries)
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Github = Pulumi.Github;
return await Deployment.RunAsync(() =>
{
var @this = Github.GetRepository.Invoke(new()
{
Name = "example",
});
var thisGetBranch = Github.GetBranch.Invoke(new()
{
Branch = @this.Apply(getRepositoryResult => getRepositoryResult.DefaultBranch),
Repository = @this.Apply(getRepositoryResult => getRepositoryResult.Name),
});
var thisGetTree = Github.GetTree.Invoke(new()
{
Recursive = false,
Repository = @this.Apply(getRepositoryResult => getRepositoryResult.Name),
TreeSha = thisGetBranch.Apply(getBranchResult => getBranchResult.Sha),
});
return new Dictionary<string, object?>
{
["entries"] = thisGetTree.Apply(getTreeResult => getTreeResult.Entries),
};
});
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 {
this, err := github.LookupRepository(ctx, &github.LookupRepositoryArgs{
Name: pulumi.StringRef("example"),
}, nil)
if err != nil {
return err
}
thisGetBranch, err := github.LookupBranch(ctx, &github.LookupBranchArgs{
Branch: this.DefaultBranch,
Repository: this.Name,
}, nil)
if err != nil {
return err
}
thisGetTree, err := github.GetTree(ctx, &github.GetTreeArgs{
Recursive: pulumi.BoolRef(false),
Repository: this.Name,
TreeSha: thisGetBranch.Sha,
}, nil)
if err != nil {
return err
}
ctx.Export("entries", thisGetTree.Entries)
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.GetRepositoryArgs;
import com.pulumi.github.inputs.GetBranchArgs;
import com.pulumi.github.inputs.GetTreeArgs;
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 this = GithubFunctions.getRepository(GetRepositoryArgs.builder()
.name("example")
.build());
final var thisGetBranch = GithubFunctions.getBranch(GetBranchArgs.builder()
.branch(this_.defaultBranch())
.repository(this_.name())
.build());
final var thisGetTree = GithubFunctions.getTree(GetTreeArgs.builder()
.recursive(false)
.repository(this_.name())
.treeSha(thisGetBranch.applyValue(getBranchResult -> getBranchResult.sha()))
.build());
ctx.export("entries", thisGetTree.applyValue(getTreeResult -> getTreeResult.entries()));
}
}
variables:
this:
fn::invoke:
function: github:getRepository
arguments:
name: example
thisGetBranch:
fn::invoke:
function: github:getBranch
arguments:
branch: ${this.defaultBranch}
repository: ${this.name}
thisGetTree:
fn::invoke:
function: github:getTree
arguments:
recursive: false
repository: ${this.name}
treeSha: ${thisGetBranch.sha}
outputs:
entries: ${thisGetTree.entries}

Return

A collection of values returned by getTree.

Parameters

argument

A collection of arguments for invoking getTree.


suspend fun getTree(recursive: Boolean? = null, repository: String, treeSha: String): GetTreeResult

Return

A collection of values returned by getTree.

Parameters

recursive

Setting this parameter to true returns the objects or subtrees referenced by the tree specified in tree_sha.

repository

The name of the repository.

treeSha

The SHA1 value for the tree.

See also


suspend fun getTree(argument: suspend GetTreePlainArgsBuilder.() -> Unit): GetTreeResult

Return

A collection of values returned by getTree.

Parameters

argument

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

See also