Package net.kyori.indra.gradle

Interface IndraPluginPublishingExtension

  • All Known Implementing Classes:
    IndraPluginPublishingExtensionImpl
    public interface IndraPluginPublishingExtension
    An extension providing helpers for plugin publishing.
    Since:
    1.3.0

    • Method Summary

      All Methods Instance Methods Abstract Methods Default Methods 
      Modifier and Type Method Description
      @NotNull org.gradle.api.provider.ListProperty<java.lang.String> bundleTags()
      Get tags to be included on the plugin bundle.
      default void bundleTags​(java.lang.String... bundleTags)
      Set tags to be included on the plugin bundle.
      default void bundleTags​(java.util.List<java.lang.String> bundleTags)
      Set tags to be included on the plugin bundle.
      default void plugin​(@NotNull java.lang.String id, @NotNull java.lang.String mainClass, @NotNull java.lang.String displayName)
      Register a plugin to have marker validated, and to be deployed to the Gradle Plugin Portal.
      default void plugin​(@NotNull java.lang.String id, @NotNull java.lang.String mainClass, @NotNull java.lang.String displayName, @Nullable java.lang.String description)
      Register a plugin to have marker validated, and to be deployed to the Gradle Plugin Portal.
      void plugin​(@NotNull java.lang.String id, @NotNull java.lang.String mainClass, @NotNull java.lang.String displayName, @Nullable java.lang.String description, @Nullable java.util.List<java.lang.String> tags)
      Register a plugin to have marker validated, and to be deployed to the Gradle Plugin Portal.
      @NotNull org.gradle.api.provider.Property<java.lang.String> pluginIdBase()
      A property providing the base id that indra-declared plugin ids are relative to.
      default void pluginIdBase​(@NotNull java.lang.String idBase)
      Set the base id that indra-declared plugin ids are relative to.
      @NotNull org.gradle.api.provider.Property<java.lang.String> website()
      Get the website to link to from this plugin's page on the plugin portal.
      default void website​(@NotNull java.lang.String website)
      Set the website to link to from this plugin's page on the plugin portal.

    • Method Detail

      • bundleTags

        @NotNull
@NotNull org.gradle.api.provider.ListProperty<java.lang.String> bundleTags()
        Get tags to be included on the plugin bundle.
        Returns:
        a property providing the tags used for the overall bundle on the plugin portal
        Since:
        2.0.0

      • bundleTags

        default void bundleTags​(java.util.List<java.lang.String> bundleTags)
        Set tags to be included on the plugin bundle.
        Parameters:
        bundleTags - the bundle tags
        Since:
        2.0.0

      • bundleTags

        default void bundleTags​(java.lang.String... bundleTags)
        Set tags to be included on the plugin bundle.
        Parameters:
        bundleTags - the bundle tags
        Since:
        2.0.0

      • pluginIdBase

        @NotNull
@NotNull org.gradle.api.provider.Property<java.lang.String> pluginIdBase()
        A property providing the base id that indra-declared plugin ids are relative to.
        Returns:
        the base for relative plugin ids
        Since:
        2.0.0

      • pluginIdBase

        default void pluginIdBase​(@NotNull
                          @NotNull java.lang.String idBase)
        Set the base id that indra-declared plugin ids are relative to.
        Parameters:
        idBase - the base for relative plugin ids
        Since:
        2.0.0

      • website

        @NotNull
@NotNull org.gradle.api.provider.Property<java.lang.String> website()
        Get the website to link to from this plugin's page on the plugin portal.
        Returns:
        the website property
        Since:
        2.0.0

      • website

        default void website​(@NotNull
                     @NotNull java.lang.String website)
        Set the website to link to from this plugin's page on the plugin portal.
        Parameters:
        website - the URL of the website
        Since:
        2.0.0

      • plugin

        default void plugin​(@NotNull
                    @NotNull java.lang.String id,
                    @NotNull
                    @NotNull java.lang.String mainClass,
                    @NotNull
                    @NotNull java.lang.String displayName)
        Register a plugin to have marker validated, and to be deployed to the Gradle Plugin Portal.

        If no tags are set on the global plugin bundle, then the first provided set of tags will be applied.

        Parameters:
        id - the relative plugin id
        mainClass - the fully qualified name of the plugin class
        displayName - the display name for the plugin on the Gradle Plugin Portal
        Since:
        2.0.0

      • plugin

        default void plugin​(@NotNull
                    @NotNull java.lang.String id,
                    @NotNull
                    @NotNull java.lang.String mainClass,
                    @NotNull
                    @NotNull java.lang.String displayName,
                    @Nullable
                    @Nullable java.lang.String description)
        Register a plugin to have marker validated, and to be deployed to the Gradle Plugin Portal.

        If no tags are set on the global plugin bundle, then the first provided set of tags will be applied.

        Parameters:
        id - the relative plugin id
        mainClass - the fully qualified name of the plugin class
        displayName - the display name for the plugin on the Gradle Plugin Portal
        description - the plugin description
        Since:
        2.0.0

      • plugin

        void plugin​(@NotNull
            @NotNull java.lang.String id,
            @NotNull
            @NotNull java.lang.String mainClass,
            @NotNull
            @NotNull java.lang.String displayName,
            @Nullable
            @Nullable java.lang.String description,
            @Nullable
            @Nullable java.util.List<java.lang.String> tags)
        Register a plugin to have marker validated, and to be deployed to the Gradle Plugin Portal.

        The id is relative to pluginIdBase(), which is by default the project's group id. Main class is absolute.

        If no tags are set on the global plugin bundle, then the first provided set of tags will be applied.

        Parameters:
        id - the relative plugin id
        mainClass - the fully qualified name of the plugin class
        displayName - the display name for the plugin on the Gradle Plugin Portal
        description - the plugin description
        tags - tags used for the plugin on the plugin portal
        Since:
        2.0.0