OpenAperture.Builder.SourceRepo

This module provides a data struct to represent a source repository. Initializing the struct will download the contents of the repo and populate the struct with all available information

Summary↑

cleanup(repo)

Method to cleanup any artifacts associated with the deploy repo PID

create!(workflow_id, source_repo_url, source_repo_git_ref)

Method to create a populated SourceRepo

download!(repo, source_repo_url, source_repo_git_ref)

Method to download the repository locally

get_current_commit_hash!(source_repo)
get_current_commit_hash(source_repo)
get_openaperture_info(repo)

Method to retrieve an OpenAperture repo info from the output directory

Types ↑

t :: %OpenAperture.Builder.SourceRepo{github_source_repo: term, output_dir: term}

Functions

cleanup(repo)

Specs:

  • cleanup(pid) :: term

Method to cleanup any artifacts associated with the deploy repo PID

Options

The repo option defines the repo PID

create!(workflow_id, source_repo_url, source_repo_git_ref)

Specs:

Method to create a populated SourceRepo

download!(repo, source_repo_url, source_repo_git_ref)

Specs:

Method to download the repository locally

get_current_commit_hash(source_repo)

Specs:

get_current_commit_hash!(source_repo)

Specs:

get_openaperture_info(repo)

Specs:

  • get_openaperture_info(pid) :: {:ok, pid} | {:error, String.t}

Method to retrieve an OpenAperture repo info from the output directory

Options

The ‘repo’ option defines the repo PID

Return values

Map