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

Copy Markdown View Source

An immutable git commit.

Summary

Types

t()

Functions

ancestor_release_tag(git_commit, optional_args \\ [])

The latest semver release tag reachable from this commit.

author_email(git_commit)

Git author email.

author_name(git_commit)

Git author name.

authored_date(git_commit)

Git author date, in RFC3339 format.

committed_date(git_commit)

Git committer date, in RFC3339 format.

committer_email(git_commit)

Git committer email.

committer_name(git_commit)

Git committer name.

id(git_commit)

A unique identifier for this GitCommit.

message(git_commit)

Full commit message.

message_body(git_commit)

Commit message body, excluding the headline.

message_headline(git_commit)

First line of the commit message.

parent_shas(git_commit)

Parent commit SHAs.

release_tag(git_commit, optional_args \\ [])

The latest semver release tag that points directly at this commit.

sha(git_commit)

The full commit SHA.

short_sha(git_commit)

The abbreviated commit SHA.

tree(git_commit, optional_args \\ [])

The filesystem tree at this commit.

Types

t()

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

Functions

ancestor_release_tag(git_commit, optional_args \\ [])

@spec ancestor_release_tag(t(), [{:include_pre_release, boolean() | nil}]) ::
  {:ok, Dagger.GitRef.t() | nil} | {:error, term()}

The latest semver release tag reachable from this commit.

author_email(git_commit)

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

Git author email.

author_name(git_commit)

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

Git author name.

authored_date(git_commit)

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

Git author date, in RFC3339 format.

committed_date(git_commit)

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

Git committer date, in RFC3339 format.

committer_email(git_commit)

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

Git committer email.

committer_name(git_commit)

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

Git committer name.

id(git_commit)

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

A unique identifier for this GitCommit.

message(git_commit)

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

Full commit message.

message_body(git_commit)

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

Commit message body, excluding the headline.

message_headline(git_commit)

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

First line of the commit message.

parent_shas(git_commit)

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

Parent commit SHAs.

release_tag(git_commit, optional_args \\ [])

@spec release_tag(t(), [{:include_pre_release, boolean() | nil}]) ::
  {:ok, Dagger.GitRef.t() | nil} | {:error, term()}

The latest semver release tag that points directly at this commit.

sha(git_commit)

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

The full commit SHA.

short_sha(git_commit)

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

The abbreviated commit SHA.

tree(git_commit, 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 commit.