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.

  • Method Details

    • getDisplayName

      org.gradle.api.provider.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. This also is used with manifestDefaults(org.gradle.api.java.archives.Manifest, java.lang.String) to reduce buildscript boilerplate.

      Returns:
      The property for the display name

    • getVendor

      org.gradle.api.provider.Property<String> getVendor()

      The vendor for the project.

      This is used with manifestDefaults(org.gradle.api.java.archives.Manifest, java.lang.String) to reduce buildscript boilerplate.

      Returns:
      The property for the vendor

    • manifestDefaults

      default void manifestDefaults(org.gradle.api.java.archives.Manifest manifest, String packageName)
      Sets the default attributes for the given manifest and attaches the given package name as the section name.
      Parameters:
      manifest - The manifest to apply defaults to
      packageName - The package name to use as the section name

    • manifestDefaults

      void manifestDefaults(org.gradle.api.java.archives.Manifest manifest, String packageName, Map<? extends CharSequence, ?> additionalEntries)
      Sets the default attributes for the given manifest and attaches the given package name as the section name.
      Parameters:
      manifest - The manifest to apply defaults to
      packageName - The package name to use as the section name
      additionalEntries - A map of additional entries to add
      API Note:
      GradleUtils will automatically attempt to GradleUtilsExtension.unpack(java.lang.Object) any values in the maps.

    • pluginDevDefaults

      void pluginDevDefaults(org.gradle.api.artifacts.ConfigurationContainer configurations, CharSequence gradleVersion)

      Applies known defaults for Minecraft Forge's Gradle plugins.

      • For all configurations that contain (ignoring case) "runtimeElements", the GradlePluginApiVersion.GRADLE_PLUGIN_API_VERSION_ATTRIBUTE attribute with the value of the given Gradle version.
      Parameters:
      configurations - The configurations container to apply defaults to
      gradleVersion - The Gradle version to target

    • pluginDevDefaults

      void pluginDevDefaults(org.gradle.api.artifacts.ConfigurationContainer configurations, org.gradle.api.provider.Provider<? extends CharSequence> gradleVersion)

      Applies known defaults for Minecraft Forge's Gradle plugins.

      • For all configurations that contain (ignoring case) "runtimeElements", the GradlePluginApiVersion.GRADLE_PLUGIN_API_VERSION_ATTRIBUTE attribute with the value of the given Gradle version.
      Parameters:
      configurations - The configurations container to apply defaults to
      gradleVersion - The Gradle version to target

    • pluginDevDefaults

      default void pluginDevDefaults(org.gradle.api.artifacts.ConfigurationContainer configurations, org.gradle.api.provider.ProviderConvertible<? extends CharSequence> gradleVersion)

      Applies known defaults for Minecraft Forge's Gradle plugins.

      • For all configurations that contain (ignoring case) "runtimeElements", the GradlePluginApiVersion.GRADLE_PLUGIN_API_VERSION_ATTRIBUTE attribute with the value of the given Gradle version.
      Parameters:
      configurations - The configurations container to apply defaults to
      gradleVersion - The Gradle version to target

    • promote

      default org.gradle.api.tasks.TaskProvider<? extends PromotePublication> promote(org.gradle.api.publish.maven.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

      org.gradle.api.tasks.TaskProvider<? extends PromotePublication> promote(org.gradle.api.publish.maven.MavenPublication publication, org.gradle.api.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