View Source Dagger.GitModuleSource (dagger v0.14.0)

Module source originating from a git repo.

Summary

Functions

The ref to clone the root of the git repo from

The resolved commit of the git repo this source points to.

The directory containing everything needed to load load and use the module.

The URL to access the web view of the repository (e.g., GitHub, GitLab, Bitbucket)

The URL to the source's git repo in a web browser

A unique identifier for this GitModuleSource.

The clean module name of the root of the module

The path to the root of the module source under the context directory. This directory contains its configuration file. It also contains its source code (possibly as a subdirectory).

The specified version of the git repo this source points to.

Types

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

Functions

Link to this function

clone_ref(git_module_source)

View Source
@spec clone_ref(t()) :: {:ok, String.t()} | {:error, term()}

The ref to clone the root of the git repo from

Link to this function

commit(git_module_source)

View Source
@spec commit(t()) :: {:ok, String.t()} | {:error, term()}

The resolved commit of the git repo this source points to.

Link to this function

context_directory(git_module_source)

View Source
@spec context_directory(t()) :: Dagger.Directory.t()

The directory containing everything needed to load load and use the module.

Link to this function

html_repo_url(git_module_source)

View Source
@spec html_repo_url(t()) :: {:ok, String.t()} | {:error, term()}

The URL to access the web view of the repository (e.g., GitHub, GitLab, Bitbucket)

Link to this function

html_url(git_module_source)

View Source
@spec html_url(t()) :: {:ok, String.t()} | {:error, term()}

The URL to the source's git repo in a web browser

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

A unique identifier for this GitModuleSource.

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

The clean module name of the root of the module

Link to this function

root_subpath(git_module_source)

View Source
@spec root_subpath(t()) :: {:ok, String.t()} | {:error, term()}

The path to the root of the module source under the context directory. This directory contains its configuration file. It also contains its source code (possibly as a subdirectory).

Link to this function

version(git_module_source)

View Source
@spec version(t()) :: {:ok, String.t()} | {:error, term()}

The specified version of the git repo this source points to.