Package io.github.intisy.gradle.github.api.capability

Interface SourceBuilds

All Known Implementing Classes:

GitHubSourceBuilds

public interface SourceBuilds

Builds a git repository from source and caches the resulting jar by resolved commit.

Method Summary

Modifier and Type	Method	Description
File	buildFromGit(String cloneUrl, String ref)	Builds any git repository from source, identified by an explicit clone URL rather than a GitHub owner/repo, so hosts other than github.com are equally supported.
File	buildFromSource(String owner, String repo, String branch, String commitSha)	Builds a GitHub repository from source, identified by owner and repo.

Method Details

buildFromSource

File buildFromSource(String owner,
 String repo,
 String branch,
 String commitSha)
              throws IOException

Builds a GitHub repository from source, identified by owner and repo.

Parameters:

owner - the repository owner.

repo - the repository name.

branch - the branch to clone or pull, or null for the current/default branch.

commitSha - the commit to build, or null to use the branch's latest commit.

Returns:

the cached jar for the resolved commit, built only when not already cached.

Throws:

IOException - if the clone/pull, checkout, or build itself fails.

buildFromGit

File buildFromGit(String cloneUrl,
 String ref)
           throws IOException

Builds any git repository from source, identified by an explicit clone URL rather than a GitHub owner/repo, so hosts other than github.com are equally supported.

Parameters:

cloneUrl - the exact URL to clone from.

ref - the branch, tag, or commit to build, or null for the remote's default branch.

Returns:

the cached jar for the resolved ref, built only when not already cached.

Throws:

IOException - if the clone, checkout, or build itself fails.