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

Class PackagesExtension

java.lang.Object

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

public class PackagesExtension
extends java.lang.Object

Declares the GitHub Packages repositories a build resolves dependencies from.

 github {
     packages {
         from "my-org/libs"
         from("my-org/core") { group = "com.example" }
     }
 }

 dependencies {
     implementation "com.example:common:1.0.0"
     testImplementation testFixtures("com.example:common:1.0.0")
 }
 

from is repeatable, and each entry becomes an ordinary Maven repository, so dependencies resolved through it are ordinary Gradle dependencies with full metadata.

API Note:

Deliberately no new coordinate form. A githubImplementation "OWNER:REPO:TAG" triple names a repository and a tag, while a package is addressed by group, artifact and version, and one repository can hold several artifacts under a group its own name never appears in. Reusing the triple would have to guess that mapping.

Constructor Summary

Constructors

Constructor and Description
PackagesExtension()

Method Summary

Modifier and Type	Method and Description
PackageSourceEntry	from(java.lang.String repository) Resolves dependencies from a repository's GitHub Packages registry.
void	from(java.lang.String repository, org.gradle.api.Action<? super PackageSourceEntry> action) Resolves dependencies from a repository's GitHub Packages registry, configured by the given Gradle action.
void	from(java.lang.String repository, groovy.lang.Closure<?> closure) Resolves dependencies from a repository's GitHub Packages registry, configured by the given Groovy closure.
java.util.List<PackageSourceEntry>	getSources()

Methods inherited from class java.lang.Object

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

Constructor Detail

PackagesExtension

public PackagesExtension()

Method Detail

getSources

public java.util.List<PackageSourceEntry> getSources()

Returns:

every declared from entry, in declaration order.

from

public PackageSourceEntry from(java.lang.String repository)

Resolves dependencies from a repository's GitHub Packages registry.

Parameters:

repository - the repository, as "owner/repo".

Returns:

the entry, so a caller holding it can narrow it further.

from

public void from(java.lang.String repository,
                 org.gradle.api.Action<? super PackageSourceEntry> action)

Resolves dependencies from a repository's GitHub Packages registry, configured by the given Gradle action.

Parameters:

repository - the repository, as "owner/repo".

action - action that configures the entry.

from

public void from(java.lang.String repository,
                 groovy.lang.Closure<?> closure)

Resolves dependencies from a repository's GitHub Packages registry, configured by the given Groovy closure.

Parameters:

repository - the repository, as "owner/repo".

closure - closure that configures the entry.