Skip to contents

A component repo hosted on GitHub. When the object is created, ref is resolved to a commit SHA and the repository tarball for that commit is downloaded and extracted to a temporary directory. Resolved SHAs are cached per ref and tarballs per commit for the session, so all lookups afterwards are local. Restart the session to pick up new commits on a branch.

spec is a remotes-style repository reference: owner/repo, owner/repo/subdir, owner/repo@ref or a combination.

Transient API errors (HTTP 5xx and network failures) are retried. The number of attempts is set by the max_tries option. See mighty.component-options.

Requires the gh and remotes packages. Private repositories need a GitHub token. gh reads it from the GITHUB_PAT or GITHUB_TOKEN environment variable, or the Git credential store. See gh::gh_token().

Usage

mighty_repo_github(spec)

Arguments

spec

character(1) GitHub repository reference. See description.

Value

A mighty_repo_github object. It inherits from mighty_repo_local(), with path set to the downloaded repository or its subdir.

See also

Examples

if (FALSE) { # interactive() && rlang::is_installed(c("gh", "remotes"))
repo <- mighty_repo_github(
  spec = "NovoNordisk-OpenSource/mighty.standards/components@main"
)
find_component(component = "dummy", repos = repo)
}