Dagger.GitRepository (dagger v1.0.0-beta.11)

Copy Markdown View Source

A git repository.

Summary

Functions

Creates a synthetic workspace from this git repository.

Returns details of a branch.

branches that match any of the given glob patterns.

Returns details of a commit.

Returns details for HEAD.

A unique identifier for this GitRepository.

Return the latest stable release tag, falling back to HEAD when no release exists.

Returns details of a ref.

Returns details of a tag.

tags that match any of the given glob patterns.

Returns the changeset of uncommitted changes in the git repository.

The URL of the git repository.

Types

t()

@type t() :: %Dagger.GitRepository{client: term(), query_builder: term()}

Functions

as_workspace(git_repository, optional_args \\ [])

@spec as_workspace(t(), [{:cwd, String.t() | nil}]) :: Dagger.Workspace.t()

Creates a synthetic workspace from this git repository.

branch(git_repository, name)

@spec branch(t(), String.t()) :: Dagger.GitRef.t()

Returns details of a branch.

branches(git_repository, optional_args \\ [])

@spec branches(t(), [{:patterns, [String.t()]}]) ::
  {:ok, [String.t()]} | {:error, term()}

branches that match any of the given glob patterns.

commit(git_repository, id)

@spec commit(t(), String.t()) :: Dagger.GitCommit.t()

Returns details of a commit.

head(git_repository)

@spec head(t()) :: Dagger.GitRef.t()

Returns details for HEAD.

id(git_repository)

@spec id(t()) :: {:ok, String.t()} | {:error, term()}

A unique identifier for this GitRepository.

latest(git_repository)

@spec latest(t()) :: Dagger.GitRef.t()

Return the latest stable release tag, falling back to HEAD when no release exists.

Release selection accepts an optional "v" prefix, incomplete versions, and zero-padded numeric components. This operation is pinned.

ref(git_repository, name)

@spec ref(t(), String.t()) :: Dagger.GitRef.t()

Returns details of a ref.

tag(git_repository, name)

@spec tag(t(), String.t()) :: Dagger.GitRef.t()

Returns details of a tag.

tags(git_repository, optional_args \\ [])

@spec tags(t(), [{:patterns, [String.t()]}]) :: {:ok, [String.t()]} | {:error, term()}

tags that match any of the given glob patterns.

uncommitted(git_repository)

@spec uncommitted(t()) :: Dagger.Changeset.t()

Returns the changeset of uncommitted changes in the git repository.

url(git_repository)

@spec url(t()) :: {:ok, String.t() | nil} | {:error, term()}

The URL of the git repository.