Interface ChangelogExtension

public sealed interface ChangelogExtension

Configuration for the Changelog plugin.

This extension is added to the project when the net.minecraftforge.changelog plugin is applied.

Enabling Generation

To enable changelog generation for your project, a start marker for the changelog must be specified. This can be done by calling from(String) or one of its sister methods.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    NAME
    The name for this extension.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    from(String marker)
    Sets the changelog start marker to use when generating the changelog.
    void
    from(org.gradle.api.provider.Provider<?> marker)
    Sets the changelog start marker to use when generating the changelog.
    default void
    from(org.gradle.api.provider.ProviderConvertible<?> marker)
    Sets the changelog start marker to use when generating the changelog.
    void
    fromBase()
    Sets the changelog start marker to the last merge base commit.
    org.gradle.api.provider.Property<Boolean>
    getIncludeSubprojects()
    If publishing all, this property determines if subproject publications should be included.
    org.gradle.api.provider.Property<Boolean>
    getPublishAll()
    The property that sets if the changelog generation should be enabled for all maven publications in the project.
    void
    publish(org.gradle.api.publish.maven.MavenPublication publication)
    Sets this project's changelog as an artifact for the given publication.

  • Field Details

  • Method Details

    • fromBase

      void fromBase()
      Sets the changelog start marker to the last merge base commit.
      See Also:

    • from

      void from(String marker)
      Sets the changelog start marker to use when generating the changelog. This can be a tag name or a commit SHA.
      Parameters:
      marker - The start marker for the changelog
      API Note:
      To start from the last merge base commit, use fromBase()

    • from

      void from(org.gradle.api.provider.Provider<?> marker)

      Sets the changelog start marker to use when generating the changelog. This can be a tag name or a commit SHA.

      If null, the changelog will start from the last merge base commit.

      Parameters:
      marker - The start marker for the changelog

    • from

      default void from(org.gradle.api.provider.ProviderConvertible<?> marker)

      Sets the changelog start marker to use when generating the changelog. This can be a tag name or a commit SHA.

      If null, the changelog will start from the last merge base commit.

      Parameters:
      marker - The start marker for the changelog

    • publish

      void publish(org.gradle.api.publish.maven.MavenPublication publication)
      Sets this project's changelog as an artifact for the given publication.
      Parameters:
      publication - The publication

    • getPublishAll

      org.gradle.api.provider.Property<Boolean> getPublishAll()
      The property that sets if the changelog generation should be enabled for all maven publications in the project.
      Returns:
      The property for if the changelog generation is enabled for all maven publications
      API Note:
      To set up publishing for all subprojects, as long as that subproject does not have another changelog plugin overriding the propagation.

    • getIncludeSubprojects

      org.gradle.api.provider.Property<Boolean> getIncludeSubprojects()

      If publishing all, this property determines if subproject publications should be included.

      The changelog from the parent project will be copied to the subproject using a CopyChangelog task as long as the subproject does not have another changelog plugin overriding the propagation.

      Returns:
      The property for if the changelog generation for publishing to all should include subprojects