Package org.spongepowered.gradle.ore

Interface OreDeploymentExtension

  • All Known Implementing Classes:
    OreDeploymentExtensionImpl
    public interface OreDeploymentExtension
    Properties to configure all ore deployment tasks.

    These options can be overridden per-task if needed.

    Since:
    2.1.0

    • Method Summary

      All Methods Instance Methods Abstract Methods Default Methods 
      Modifier and Type Method Description
      @NotNull org.gradle.api.provider.Property<java.lang.String> apiKey()
      Get the API key to use for authentication.
      default void apiKey​(@NotNull java.lang.String apiKey)
      Set the API key to use for authentication.
      default void defaultPublication​(@NotNull org.gradle.api.Action<? super OrePublication> configureAction)
      Configure the default publication, creating it if necessary.
      @NotNull org.gradle.api.provider.Property<java.lang.String> oreEndpoint()
      The Ore host to publish to.
      default void oreEndpoint​(@NotNull java.lang.String endpoint)
      Set the ore host to publish to.
      @NotNull org.gradle.api.NamedDomainObjectContainer<OrePublication> publications()
      Get publications for this project.
      default void publications​(@NotNull org.gradle.api.Action<org.gradle.api.NamedDomainObjectContainer<OrePublication>> configureAction)
      Configure the publications on this project.

    • Method Detail

      • oreEndpoint

        @NotNull
@NotNull org.gradle.api.provider.Property<java.lang.String> oreEndpoint()
        The Ore host to publish to.

        Default: https://ore.spongepowered.org/

        Returns:
        a property supplying the ore endpoint.
        Since:
        2.1.0

      • oreEndpoint

        default void oreEndpoint​(@NotNull
                         @NotNull java.lang.String endpoint)
        Set the ore host to publish to.
        Parameters:
        endpoint - the ore endpoint
        Since:
        2.1.0
        See Also:
        oreEndpoint()

      • apiKey

        @NotNull
@NotNull org.gradle.api.provider.Property<java.lang.String> apiKey()
        Get the API key to use for authentication.

        This should be a v2 API key with create_version permissions.

        For security reasons, this property should be set to the value of a gradle property or environment variable rather than the literal API key.

        Default: the value of the environment variable ORE_TOKEN.

        Returns:
        the API key property
        Since:
        2.1.0

      • apiKey

        default void apiKey​(@NotNull
                    @NotNull java.lang.String apiKey)
        Set the API key to use for authentication.
        Parameters:
        apiKey - the api key
        Since:
        2.1.0
        See Also:
        apiKey()

      • defaultPublication

        default void defaultPublication​(@NotNull
                                @NotNull org.gradle.api.Action<? super OrePublication> configureAction)
        Configure the default publication, creating it if necessary.

        This publication will be automatically configured when SpongeGradle is present.

        Parameters:
        configureAction - the action to configure
        Since:
        2.1.0

      • publications

        @NotNull
@NotNull org.gradle.api.NamedDomainObjectContainer<OrePublication> publications()
        Get publications for this project.
        Returns:
        publications collection
        Since:
        2.1.0

      • publications

        default void publications​(@NotNull
                          @NotNull org.gradle.api.Action<org.gradle.api.NamedDomainObjectContainer<OrePublication>> configureAction)
        Configure the publications on this project.
        Parameters:
        configureAction - the configure action
        Since:
        2.1.0