Package net.kyori.indra

Interface IndraExtension

All Known Implementing Classes:
IndraExtensionImpl
public interface IndraExtension
Extension exposing extra functionality provided by Indra.
Since:
2.0.0

  • Method Details

    • javaVersions

      @NotNull @NotNull JavaToolchainVersions javaVersions()
      Options controlling JVM toolchain versions.
      Returns:
      the java toolchain version configuration
      Since:
      2.0.0

    • javaVersions

      void javaVersions(@NotNull @NotNull org.gradle.api.Action<JavaToolchainVersions> action)
      Configure the JVM versioning configuration.
      Parameters:
      action - the action to apply to the JVM versioning configuration
      Since:
      2.0.0

    • ci

      @NotNull @NotNull org.gradle.api.provider.Property<ContinuousIntegration> ci()

    • ci

      default void ci(@NotNull @NotNull ContinuousIntegration ci)

    • ci

      default void ci(@NotNull @NotNull org.gradle.api.Action<ContinuousIntegration.Builder> configureAction)

    • jenkins

      default void jenkins(@NotNull @NotNull String url)

    • issues

      @NotNull @NotNull org.gradle.api.provider.Property<Issues> issues()

    • issues

      default void issues(@NotNull @NotNull Issues issues)

    • issues

      default void issues(@NotNull @NotNull org.gradle.api.Action<Issues.Builder> configureAction)

    • scm

      @NotNull @NotNull org.gradle.api.provider.Property<SourceCodeManagement> scm()

    • scm

      default void scm(@NotNull @NotNull SourceCodeManagement scm)

    • scm

      default void scm(@NotNull @NotNull org.gradle.api.Action<SourceCodeManagement.Builder> configureAction)

    • license

      @NotNull @NotNull org.gradle.api.provider.Property<License> license()

    • license

      default void license(@NotNull @NotNull License license)

    • license

      default void license(@NotNull @NotNull org.gradle.api.Action<License.Builder> configureAction)

    • apache2License

      default void apache2License()

    • gpl3OnlyLicense

      default void gpl3OnlyLicense()

    • gpl3OrLaterLicense

      default void gpl3OrLaterLicense()

    • lgpl3OnlyLicense

      default void lgpl3OnlyLicense()

    • lgpl3OrLaterLicense

      default void lgpl3OrLaterLicense()

    • mitLicense

      default void mitLicense()

    • mpl2License

      default void mpl2License()

    • github

      default void github(@NotNull @NotNull String user, @NotNull @NotNull String repo)

    • github

      void github(@NotNull @NotNull String user, @NotNull @NotNull String repo, @Nullable @Nullable org.gradle.api.Action<ApplyTo> applicable)

    • gitlab

      default void gitlab(@NotNull @NotNull String user, @NotNull @NotNull String repo)

    • gitlab

      void gitlab(@NotNull @NotNull String user, @NotNull @NotNull String repo, @Nullable @Nullable org.gradle.api.Action<ApplyTo> applicable)

    • publishAllTo

      void publishAllTo(@NotNull @NotNull String id, @NotNull @NotNull String url)

    • publishReleasesTo

      void publishReleasesTo(@NotNull @NotNull String id, @NotNull @NotNull String url)

    • publishSnapshotsTo

      void publishSnapshotsTo(@NotNull @NotNull String id, @NotNull @NotNull String url)

    • configurePublications

      void configurePublications(@NotNull @NotNull org.gradle.api.Action<org.gradle.api.publish.maven.MavenPublication> action)

    • checkstyle

      @NotNull @NotNull org.gradle.api.provider.Property<String> checkstyle()
      A property representing the version of checkstyle to be used.

      If any custom additions are applied to the checkstyle configuration, this value will be ignored.

      Returns:
      the checkstyle version property
      Since:
      2.0.0

    • checkstyle

      default void checkstyle(@NotNull @NotNull String checkstyleVersion)
      Set the version of checkstyle to be used.
      Parameters:
      checkstyleVersion - the target checkstyle version
      Since:
      2.0.0
      See Also:

    • reproducibleBuilds

      @NotNull @NotNull org.gradle.api.provider.Property<Boolean> reproducibleBuilds()
      Whether options that support reproducible builds should be enabled.

      Default: true

      Returns:
      the property configuring reproducible builds
      Since:
      2.0.0

    • reproducibleBuilds

      default void reproducibleBuilds(boolean reproducibleBuilds)
      Set whether options that support reproducible builds should be enabled.

      Default: true

      Parameters:
      reproducibleBuilds - whether to build in a way that encourages reproducibility
      Since:
      2.0.0

    • includeJavaSoftwareComponentInPublications

      @NotNull @NotNull org.gradle.api.provider.Property<Boolean> includeJavaSoftwareComponentInPublications()
      Whether the java SoftwareComponent should be automatically included in publications.

      This property does not usually need to be changed, unless working with Gradle plugins that publish in a non-standard way.

      Returns:
      the property representing this option
      Since:
      2.0.0

    • includeJavaSoftwareComponentInPublications

      default void includeJavaSoftwareComponentInPublications(boolean include)
      Set whether the java component should be included in publications.
      Parameters:
      include - whether the component should be included
      Since:
      2.0.0
      See Also:

    • signWithKeyFromPrefixedProperties

      void signWithKeyFromPrefixedProperties(String prefix)
      Configure signing to source key and password for signing from two gradle properties with the provided prefix.

      This is equivalent to invoking signWithKeyFromProperties(String, String) with ${prefix}SigningKey and ${prefix}SigningPassword as arguments.

      Parameters:
      prefix - the prefix for the two properties.
      Since:
      3.1.0
      See Also:

    • signWithKeyFromProperties

      void signWithKeyFromProperties(String keyFileOrContentsProperty, String keyPasswordProperty)
      Configure signing to source key and password for signing from Gradle properties.

      If both properties are set, this overrides Indra's default behaviour, which is to use the GPG agent for signing.

      Parameters:
      keyFileOrContentsProperty - a property containing either a path to a key file, or the ascii-armored key blob
      keyPasswordProperty - a password containing the literal password for the provided key
      Since:
      3.1.0