gradle-josm-plugin / org.openstreetmap.josm.gradle.plugin.config / GithubConfig

GithubConfig

class GithubConfig

Configuration options for the new GitHub releases feature.

Note: This is currently in beta stage, so expect sudden changes to this API anytime.

Constructors

<init>

GithubConfig(project: Project)

Configuration options for the new GitHub releases feature.

Properties

accessToken

val accessToken: String

The access token that will be used for authentication when uploading the release.

apiUrl

var apiUrl: String

The base API URL for the Github releases API. Defaults to https://api.github.com.

releasesConfig

var releasesConfig: File

The list of releases in YAML format. The file must exist and be readable, otherwise an exception is thrown on first access of this property. Defaults to the file releases.yml in Project.getProjectDir.

repositoryName

var repositoryName: String

The name of the repository to which releases will be published.

repositoryOwner

var repositoryOwner: String

The GitHub account that owns the repository to which releases will be published.

targetCommitish

var targetCommitish: String

Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Defaults to master.

uploadUrl

var uploadUrl: String

The base API URL to upload release assets. Defaults to https://uploads.github.com.

Companion Object Properties

DEFAULT_TARGET_COMMITTISH

const val DEFAULT_TARGET_COMMITTISH: String

PROPERTY_ACCESS_TOKEN

const val PROPERTY_ACCESS_TOKEN: String