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

Copy Markdown View Source

A git ref (tag, branch, or commit).

Summary

Types

t()

Functions

as_workspace(git_ref, optional_args \\ [])

Creates a synthetic workspace from this git ref.

commit(git_ref) deprecated

The resolved commit id at this ref.

commit_sha(git_ref)

The resolved commit SHA at this ref.

common_ancestor(git_ref, other)

Find the best common ancestor between this ref and another ref.

id(git_ref)

A unique identifier for this GitRef.

log(git_ref, optional_args \\ [])

Commits reachable from this ref, newest first, starting with the commit this ref resolves to.

name(git_ref)

The resolved name of this ref.

ref(git_ref) deprecated

The resolved ref name at this ref.

target_commit(git_ref)

The commit this ref resolves to.

tree(git_ref, optional_args \\ [])

The filesystem tree at this ref.

Types

t()

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

Functions

as_workspace(git_ref, optional_args \\ [])

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

Creates a synthetic workspace from this git ref.

commit(git_ref)

This function is deprecated. Use \"commitSHA\" instead. . 
@spec commit(t()) :: {:ok, String.t()} | {:error, term()}

The resolved commit id at this ref.

commit_sha(git_ref)

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

The resolved commit SHA at this ref.

common_ancestor(git_ref, other)

@spec common_ancestor(t(), t()) :: t()

Find the best common ancestor between this ref and another ref.

id(git_ref)

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

A unique identifier for this GitRef.

log(git_ref, optional_args \\ [])

@spec log(t(), limit: integer() | nil, paths: [String.t()], base: t() | nil) ::
  {:ok, [Dagger.GitCommit.t()]} | {:error, term()}

Commits reachable from this ref, newest first, starting with the commit this ref resolves to.

name(git_ref)

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

The resolved name of this ref.

ref(git_ref)

This function is deprecated. Use \"name\" instead. . 
@spec ref(t()) :: {:ok, String.t()} | {:error, term()}

The resolved ref name at this ref.

target_commit(git_ref)

@spec target_commit(t()) :: Dagger.GitCommit.t()

The commit this ref resolves to.

tree(git_ref, optional_args \\ [])

@spec tree(t(),
  discard_git_dir: boolean() | nil,
  depth: integer() | nil,
  include_tags: boolean() | nil
) ::
  Dagger.Directory.t()

The filesystem tree at this ref.