Package ca.stellardrift.ghrelease

Interface GithubReleaserExtension

All Superinterfaces:

ReleaseJobParameters

public interface GithubReleaserExtension
extends ReleaseJobParameters

Nested Class Summary

Nested classes/interfaces inherited from interface ca.stellardrift.ghrelease.ReleaseJobParameters

ReleaseJobParameters.LatestState

Method Summary

Modifier and Type	Method	Description
org.gradle.api.provider.Property<String>	getApiToken()	Get the API token used to authenticate with GitHub.
org.gradle.api.provider.Property<String>	getEnterpriseUrl()	Get an endpoint override for GitHub.

Methods inherited from interface ca.stellardrift.ghrelease.ReleaseJobParameters

getArtifacts, getDiscussionCategoryName, getDraft, getGenerateReleaseNotes, getMakeLatest, getPrerelease, getReleaseBody, getReleaseName, getRepository, getSourceBranch, getTagName

Method Details

getEnterpriseUrl

org.gradle.api.provider.Property<String> getEnterpriseUrl()

Get an endpoint override for GitHub.

Only required if using GitHub enterprise.

Returns:

the base url for the GitHub instance

getApiToken

org.gradle.api.provider.Property<String> getApiToken()

Get the API token used to authenticate with GitHub.

By default, this is read from the GITHUB_TOKEN environment variable.

Returns:

the api token property