Package io.github.duckasteroid.gradle.githubpackages

Class GithubPackagesExtension

java.lang.Object

io.github.duckasteroid.gradle.githubpackages.GithubPackagesExtension

public abstract class GithubPackagesExtension
extends Object

Extension for configuring the GitHub Packages plugin.

 githubPackages {
     owner      = 'my-org'
     repository = 'my-repo'
     // username and token default via credential resolution chain:
     // 1. gpr.user / gpr.key (gradle.properties)
     // 2. GITHUB_ACTOR / GITHUB_TOKEN (environment)
     // 3. GH_PACKAGES_READ_USER / GH_PACKAGES_READ_TOKEN (environment)
 }
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NAME

Constructor Summary

Constructors

Constructor	Description
GithubPackagesExtension(org.gradle.api.model.ObjectFactory objects, org.gradle.api.provider.ProviderFactory providers)

Method Summary

Modifier and Type	Method	Description
abstract org.gradle.api.provider.Property<String>	getOwner()	GitHub organisation or user that owns the package repository.
abstract org.gradle.api.provider.Property<String>	getProfile()	Optional named credential profile.
abstract org.gradle.api.provider.Property<String>	getRepository()	Name of the GitHub repository that hosts the packages.
abstract org.gradle.api.provider.Property<String>	getToken()	GitHub token used for authentication.
abstract org.gradle.api.provider.Property<String>	getUsername()	GitHub username used for authentication.
String	mavenUrl()	Returns the Maven URL for this GitHub Packages repository.

Methods inherited from class java.lang.Object

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

Field Details

NAME

public static final String NAME

See Also:

• Constant Field Values

Constructor Details

GithubPackagesExtension

@Inject
public GithubPackagesExtension(org.gradle.api.model.ObjectFactory objects,
 org.gradle.api.provider.ProviderFactory providers)

Method Details

getOwner

public abstract org.gradle.api.provider.Property<String> getOwner()

GitHub organisation or user that owns the package repository.

getRepository

public abstract org.gradle.api.provider.Property<String> getRepository()

Name of the GitHub repository that hosts the packages.

getProfile

public abstract org.gradle.api.provider.Property<String> getProfile()

Optional named credential profile. When set, credentials are resolved from gpr.<profile>.user / gpr.<profile>.key instead of the unqualified gpr.user / gpr.key, letting a repo use a different identity (e.g. a personal GitHub account) than whatever is configured globally in ~/.gradle/gradle.properties. If no matching profile-qualified properties are found, resolution still falls through to the GH_PACKAGES_READ_* and GITHUB_ACTOR/GITHUB_TOKEN environment variable tiers - it deliberately does not fall back to the unqualified gpr.user/gpr.key.

getUsername

public abstract org.gradle.api.provider.Property<String> getUsername()

GitHub username used for authentication. Resolved via three-tier fallback:

1. gpr.user from gradle.properties (project or ~/.gradle/gradle.properties), or gpr.<profile>.user when getProfile() is set
2. GH_PACKAGES_READ_USER environment variable
3. GITHUB_ACTOR environment variable

getToken

public abstract org.gradle.api.provider.Property<String> getToken()

GitHub token used for authentication. Resolved via three-tier fallback:

1. gpr.key from gradle.properties (project or ~/.gradle/gradle.properties), or gpr.<profile>.key when getProfile() is set
2. GH_PACKAGES_READ_TOKEN environment variable
3. GITHUB_TOKEN environment variable

mavenUrl

public String mavenUrl()

Returns the Maven URL for this GitHub Packages repository.