io.github.intisy.gradle.github.plugin.extension

Class GitSourceEntry

java.lang.Object

io.github.intisy.gradle.github.plugin.extension.GitSourceEntry

public class GitSourceEntry
extends java.lang.Object

A single sources { git { } } entry: an arbitrary git repository to clone, build, and add to a native Gradle configuration.

 sources {
     git {
         url = "https://gitlab.com/me/lib.git"
         ref = "main"                 // branch, tag or commit; optional, default the remote's default branch
         dir = "java"                 // gradle project directory; optional, default the checkout root
         modules = "routing contracts" // modules whose jars to take; optional, default the root jar
         into = "implementation"      // native configuration; optional, default "implementation"
     }
 }
 

Constructor Summary

Constructors

Constructor and Description
GitSourceEntry()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDir()
java.lang.String	getInto()
java.util.List<java.lang.String>	getModules()
java.lang.String	getRef()
java.lang.String	getUrl()
void	setDir(java.lang.String dir)
void	setInto(java.lang.String into)
void	setModules(java.lang.String modules)
void	setRef(java.lang.String ref)
void	setUrl(java.lang.String url)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GitSourceEntry

public GitSourceEntry()

Method Detail

setUrl

public void setUrl(java.lang.String url)

Parameters:

url - the exact URL to clone from; any git host, not just github.com.

getUrl

public java.lang.String getUrl()

Returns:

the exact URL to clone from, or null if not set.

setRef

public void setRef(java.lang.String ref)

Parameters:

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

getRef

public java.lang.String getRef()

Returns:

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

setDir

public void setDir(java.lang.String dir)

Parameters:

dir - 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.

getDir

public java.lang.String getDir()

Returns:

the gradle project directory relative to the checkout root, or null if not set.

setModules

public void setModules(java.lang.String modules)

Parameters:

modules - whitespace-separated gradle module names whose jars to take, or null to take the single jar the root project produces.

getModules

public java.util.List<java.lang.String> getModules()

Returns:

the declared module names, in declaration order; empty when none were named.

setInto

public void setInto(java.lang.String into)

Parameters:

into - the native Gradle configuration the built jar is added to. Defaults to "implementation".

getInto

public java.lang.String getInto()

Returns:

the native Gradle configuration the built jar is added to.