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

Modifier and Type	Method	Description
org.gradle.api.provider.ListProperty<String>	bundleTags()
default void	bundleTags(List<String> bundleTags)
default void	plugin(String id, String mainClass, String displayName)	Register a plugin to have marker validated, and to be deployed to the Gradle Plugin Portal.
default void	plugin(String id, String mainClass, String displayName, @Nullable String description)	Register a plugin to have marker validated, and to be deployed to the Gradle Plugin Portal.
void	plugin(String id, String mainClass, String displayName, @Nullable String description, @Nullable List<String> tags)	Register a plugin to have marker validated, and to be deployed to the Gradle Plugin Portal.
org.gradle.api.provider.Property<String>	pluginIdBase()	A property providing the base id that indra-declared plugin ids are relative to.
default void	pluginIdBase(String idBase)

Method Detail

bundleTags

org.gradle.api.provider.ListProperty<String> bundleTags()

bundleTags

default void bundleTags(List<String> bundleTags)

pluginIdBase

org.gradle.api.provider.Property<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(String idBase)

plugin

default void plugin(String id,
                    String mainClass,
                    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(String id,
                    String mainClass,
                    String displayName,
                    @Nullable 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(String id,
            String mainClass,
            String displayName,
            @Nullable String description,
            @Nullable List<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