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 and Description
default java.io.File	buildFromGit(java.lang.String cloneUrl, java.lang.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.
java.util.List<java.io.File>	buildFromGit(java.lang.String cloneUrl, java.lang.String ref, java.lang.String gradleDir, java.util.List<java.lang.String> modules) Builds a multi-module git repository from source, taking one jar per named module.
java.io.File	buildFromSource(java.lang.String owner, java.lang.String repo, java.lang.String branch, java.lang.String commitSha) Builds a GitHub repository from source, identified by owner and repo.

Method Detail

buildFromSource

java.io.File buildFromSource(java.lang.String owner,
                             java.lang.String repo,
                             java.lang.String branch,
                             java.lang.String commitSha)
                      throws java.io.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:

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

buildFromGit

default java.io.File buildFromGit(java.lang.String cloneUrl,
                                  java.lang.String ref)
                           throws java.io.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:

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

Implementation Note:

The single-jar case is the module-less case, so it delegates rather than being implemented twice.

buildFromGit

java.util.List<java.io.File> buildFromGit(java.lang.String cloneUrl,
                                          java.lang.String ref,
                                          java.lang.String gradleDir,
                                          java.util.List<java.lang.String> modules)
                                   throws java.io.IOException

Builds a multi-module git repository from source, taking one jar per named module.

Parameters:

cloneUrl - the exact URL to clone from.

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

gradleDir - the gradle project directory relative to the checkout root, or null when the build lives at the root. A repository whose gradle root is a subdirectory is otherwise unbuildable, because the wrapper is not where the checkout is.

modules - the gradle module names whose jars to take, or empty for the single jar the root project produces.

Returns:

the cached jars for the resolved ref, in modules order, built only when not already cached.

Throws:

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