gradle-defaults / com.mooregreatsoftware.gradle.defaults / ReadableDefaultsExtension

ReadableDefaultsExtension

interface ReadableDefaultsExtension

A read-only set of values for DefaultsPlugin.

See Also

readableDefaultsExtension

Properties

bintrayLabels abstract val bintrayLabels: Set<String>?

The labels to set of the BinTray package, if BinTray is used.

bintrayPkg abstract val bintrayPkg: String?

The name of the BinTray package name, if BinTray is used.

bintrayRepo abstract val bintrayRepo: String?

The name of the BinTray repository to upload artifacts to, if BinTray is used.

checkerFramework abstract val checkerFramework: CheckerFrameworkExtension

Configuration for Checker Framework

compatibilityVersion abstract val compatibilityVersion: JavaVersion

The version of the Java Virtual Machine to target. Used for all the compilers that target the JVM. Defaults to the version of Java being used to run Gradle and compile the code.

contributors abstract val contributors: Set<Map<*, *>>?

The information to add to the "contributors" section of the Maven pom.xml

copyrightYears abstract val copyrightYears: String

The copyright years for the project. Used for injecting into the license headers under the key "year". Defaults to the current year.

developers abstract val developers: Set<Developer>?

The information to add to the "developers" section of the Maven pom.xml

isBintrayToCentral abstract val isBintrayToCentral: Boolean

Should the artifacts upload to BinTray also be sent to Maven Central?

issuesUrl abstract val issuesUrl: String

The URL for where to find issue reports for the project. Defaults to "$siteUrl/issues"

license abstract val license: ExtLicenseExtension

Configuration for the license plugin

licenseKey abstract val licenseKey: String

The "key" for the license. Used by BinTray. Defaults to "Apache-2.0"

licenseName abstract val licenseName: String

The name of the license. Used by Maven. Defaults to "The Apache Software License, Version 2.0"

licenseUrl abstract val licenseUrl: String

The URL of the license. Used by Maven. Defaults to http://www.apache.org/licenses/LICENSE-2.0

lombok abstract val lombok: LombokExtension

Configuration for Lombok

openSource abstract val openSource: Boolean

Is this an open-source project? If true, additional assumptions are made, such as the need to have a license on all code.

orgId abstract val orgId: String

The id of the organization (a user also counts as a one-person organization). Used as the default for computing the default values of siteUrl, vcsReadUrl and vcsWriteUrl.

orgName abstract val orgName: String?

Used for configuring BinTray and Maven metadata.

orgUrl abstract val orgUrl: String?

If there's an orgName then this is used as part of the "organization" section of the Maven pom.xml

project abstract val project: Project

The Project this is associated/registered with.

siteUrl abstract val siteUrl: String

The URL for the project. Defaults to "https://github.com/$orgId/${project.name}"

vcsReadUrl abstract val vcsReadUrl: String

The URL for where the version control system gets the source code for the project. Defaults to "${siteUrl}.git"

vcsWriteUrl abstract val vcsWriteUrl: String

The URL for where the version control system gets the source code for the project. Defaults to vcsReadUrl

Inheritors

DefaultsExtension open class DefaultsExtension : ReadableDefaultsExtension

Configuration for DefaultsPlugin.