Interface GradleUtilsExtensionForProject

All Superinterfaces:

GradleUtilsExtension

public sealed interface GradleUtilsExtensionForProject
extends GradleUtilsExtension

A subset of GradleUtilsExtension that is given to projects. Includes additional convenience methods that only apply to projects.

Field Summary

Fields inherited from interface net.minecraftforge.gradleutils.GradleUtilsExtension

forgeMaven, forgeReleaseMaven, minecraftLibsMaven, NAME

Method Summary

Modifier and Type	Method	Description
Property<String>	getDisplayName()	The display name for the project.
void	pluginDevDefaults(ConfigurationContainer configurations, CharSequence gradleVersion)
void	pluginDevDefaults(ConfigurationContainer configurations, Provider<? extends CharSequence> gradleVersion)
default void	pluginDevDefaults(ConfigurationContainer configurations, ProviderConvertible<? extends CharSequence> gradleVersion)
default TaskProvider<? extends PromotePublication>	promote(MavenPublication publication)	Promotes a publication to the Forge Files Site.
TaskProvider<? extends PromotePublication>	promote(MavenPublication publication, Action<? super PromotePublication> cfg)	Promotes a publication to the Forge Files Site.

Methods inherited from interface net.minecraftforge.gradleutils.GradleUtilsExtension

getPom, getPublishingForgeMaven, getPublishingForgeMaven, getPublishingForgeMaven, getPublishingForgeMaven, getPublishingForgeMaven, getPublishingForgeMaven, getPublishingForgeMaven, getPublishingForgeMaven, getPublishingForgeMaven, unpack, unpack

Method Details

getDisplayName

Property<String> getDisplayName()

The display name for the project.

If the relevant properties are enabled, it is used in areas such as the Javadoc window title, among other things.

Returns:

The property for the display name

pluginDevDefaults

void pluginDevDefaults(ConfigurationContainer configurations,
 CharSequence gradleVersion)

pluginDevDefaults

void pluginDevDefaults(ConfigurationContainer configurations,
 Provider<? extends CharSequence> gradleVersion)

pluginDevDefaults

default void pluginDevDefaults(ConfigurationContainer configurations,
 ProviderConvertible<? extends CharSequence> gradleVersion)

promote

default TaskProvider<? extends PromotePublication> promote(MavenPublication publication)

Promotes a publication to the Forge Files Site.

Publications that are promoted will automatically have the relevant task added as a finalizer to the publishPublicationToForgeRepository task, where the publication matches the task's publication and the repository name is "forge". The publishing Forge repo added via GradleUtilsExtension.getPublishingForgeMaven() always sets it with the name "forge".

Parameters:

publication - The publication to promote

Returns:

The provider for the promotion task

promote

TaskProvider<? extends PromotePublication> promote(MavenPublication publication,
 Action<? super PromotePublication> cfg)

Promotes a publication to the Forge Files Site.

Publications that are promoted will automatically have the relevant task added as a finalizer to the publishPublicationToForgeRepository task, where the publication matches the task's publication and the repository name is "forge". The publishing Forge repo added via GradleUtilsExtension.getPublishingForgeMaven() always sets it with the name "forge".

Parameters:

publication - The publication to promote

cfg - A configuring action for the task

Returns:

The provider for the promotion task