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

Class PackagesPublishExtension

java.lang.Object

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

public class PackagesPublishExtension
extends java.lang.Object

Configures whether publishGithub also deploys the project's Maven publications to GitHub Packages, alongside the jars it attaches to the GitHub release.

 publishGithub {
     packages {
         enabled = true
     }
 }
 

owner and repo fall back to the ones publishGithub already resolves, so an adopting build states nothing but enabled.

API Note:

The two destinations are not alternatives. GitHub Packages requires a token for every read, including a read of a public package, while a release asset on a public repository resolves anonymously; and a release asset is a bare jar, while a package carries the pom and Gradle module metadata that transitive dependencies and variants such as test fixtures resolve through. Neither one covers the other's case, which is why this sits beside the release upload rather than replacing it.

Constructor Summary

Constructors

Constructor and Description
PackagesPublishExtension()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getOwner()
java.lang.String	getRepo()
boolean	isEnabled()
void	setEnabled(boolean enabled) Controls whether publishGithub also publishes to GitHub Packages.
void	setOwner(java.lang.String owner) Overrides the owner of the repository the packages are published under.
void	setRepo(java.lang.String repo) Overrides the repository the packages are published under.

Methods inherited from class java.lang.Object

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

Constructor Detail

PackagesPublishExtension

public PackagesPublishExtension()

Method Detail

setEnabled

public void setEnabled(boolean enabled)

Controls whether publishGithub also publishes to GitHub Packages. Defaults to false.

Parameters:

enabled - whether to publish to GitHub Packages.

isEnabled

public boolean isEnabled()

Returns:

whether publishGithub also publishes to GitHub Packages.

setOwner

public void setOwner(java.lang.String owner)

Overrides the owner of the repository the packages are published under.

Parameters:

owner - the repository owner; null takes the one publishGithub resolves.

getOwner

public java.lang.String getOwner()

Returns:

the overridden owner, or null to take the one publishGithub resolves.

setRepo

public void setRepo(java.lang.String repo)

Overrides the repository the packages are published under.

Parameters:

repo - the repository name; null takes the one publishGithub resolves.

getRepo

public java.lang.String getRepo()

Returns:

the overridden repository, or null to take the one publishGithub resolves.