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

      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

    • 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