You can put your configuration in a
- Build File (build.gradle.kts etc)
- Property File (gradle.properties etc)
- System Environment Variable
This is also the order in which they will be picked up.
-
NOTE: System Environments are always in CAPITAL, i.e YAPP_POM_ARTIFACTID, and so on.
-
Yapp Publisher General Configuration
File |
Type |
|
Property file |
gradle.properties-format: |
yapp.property |
Build file |
build.gradle.kts-format |
yapp { property } |
N/A |
environment variable |
YAPP_PROPERTY |
property |
description |
example value |
(maps to) |
targets |
|
* |
A publishing target (see README.md)) or empty |
General MavenPublishing Configuration/Maven Central
File |
Type |
|
Property file |
gradle.properties-format: |
yapp.mavenPublishing.property |
Build file |
build.gradle.kts-format |
yapp { mavenPublishing { property } } } |
N/A |
environment variable |
YAPP_MAVENPUBLISHING_PROPERTY |
property |
description |
example value |
(maps to) |
mavenCentralLegacyUrl |
* |
* |
|
artifactId |
* |
* |
|
groupId |
* |
* |
|
version |
* |
* |
|
name |
* |
* |
|
description |
* |
* |
|
url |
* |
* |
|
inceptionYear |
* |
* |
|
licenseName |
* |
* |
|
licenseUrl |
* |
* |
|
licenseDistribution |
* |
* |
|
licenseComments |
* |
* |
|
developerId |
* |
* |
|
developerName |
* |
* |
|
developerEmail |
* |
* |
|
organization |
* |
* |
|
organizationUrl |
* |
* |
|
scmUrl |
* |
* |
|
scmConnection |
* |
* |
|
scmDeveloperConnection |
* |
* |
|
user |
* |
* |
|
password |
* |
* |
|
Signing
File |
Type |
|
Property file |
gradle.properties-format: |
yapp.signing.property |
Build file |
build.gradle.kts-format |
yapp { signing { property } } } |
N/A |
environment variable |
YAPP_SIGNING_PROPERTY |
property |
description |
example value |
(maps to) |
enabled |
signing enabled |
true |
|
signSnapshot |
sign snapshot |
true |
|
keySecret |
signing key password |
|
password |
keyId |
public key id (last 8) |
abc12345 |
keyId |
key |
signing key |
/path/to/gpgkey or textformat |
secretKeyRingFile |
Note: The signing key can be either a path to an gpg-key or in text format with literal newlines as \n. See the gpg
folder under the Project test resources for examples.
Gradle Plugin and publishing
File |
Type |
|
Property file |
gradle.properties-format: |
yapp.gradleplugin.property |
Build file |
build.gradle.kts-format |
yapp { gradleplugin { property } } } |
N/A |
environment variable |
YAPP_GRADLEPLUGIN_PROPERTY |
property |
description |
example value |
(maps to) |
web |
The project weburl |
"https[]://my.web.com/project" |
web |
vcs |
The projects repo url |
"https[]://github.com/johndoe/GradlePlugins" |
vcs |
tags |
Tags to describe the categories the plugin covers |
listOf("publishing", "ossrh") |
tags |
id |
groupid.plugin-name |
org.best.myplugin |
id |
class |
The extensions main class |
org.best.plugin.SimplePlugin |
implementationClass |
description |
A description specifying the intent of the plugin. |
A plugin for doing x! |
description |
displayName |
Overall plugin display name |
Gradle Do-it Plugin |
displayName |
token |
Plugin Portal token |
@£234234efkkdk |
API Key |
password |
Plugin Portal password |
<YOUR-SECRET-LOGIN-PASS |
Account password |
GitLab Package Registry Publishing
File |
Type |
|
Property file |
gradle.properties-format: |
yapp.gitlab.property |
Build file |
build.gradle.kts-format |
yapp { gitlab { property } } } |
N/A |
environment variable |
YAPP_GITLAB_PROPERTY |
GitHub Package Registry Publishing
File |
Type |
|
Property file |
gradle.properties-format: |
yapp.github.property |
Build file |
build.gradle.kts-format |
yapp { github { property } } } |
N/A |
environment variable |
YAPP_GITHUB_PROPERTY |
property |
description |
example value |
(maps to) |
user |
your github user |
johndoe |
web |
token |
your github token |
secret token |
vcs |
namespace |
github-organisation/namespace |
acmecorp |
tags |
repo |
github repo |
pluginrep |
id |