Class GenerateChangelog

java.lang.Object
org.gradle.api.internal.AbstractTask
org.gradle.api.DefaultTask
org.gradle.api.internal.ConventionTask
org.gradle.api.tasks.JavaExec
net.minecraftforge.gradleutils.shared.ToolExecBase<net.minecraftforge.gitversion.gradle.changelog.ChangelogProblems>
net.minecraftforge.gitversion.gradle.changelog.GenerateChangelog
All Implemented Interfaces:
Comparable<org.gradle.api.Task>, org.gradle.api.internal.DynamicObjectAware, org.gradle.api.internal.IConventionAware, org.gradle.api.internal.TaskInternal, org.gradle.api.Named, org.gradle.api.plugins.ExtensionAware, org.gradle.api.Task, org.gradle.process.BaseExecSpec, org.gradle.process.JavaExecSpec, org.gradle.process.JavaForkOptions, org.gradle.process.ProcessForkOptions, org.gradle.util.Configurable<org.gradle.api.Task>
public abstract class GenerateChangelog extends net.minecraftforge.gradleutils.shared.ToolExecBase<net.minecraftforge.gitversion.gradle.changelog.ChangelogProblems>
Generates a changelog for the project based on the Git history using Git Version.

  • Nested Class Summary

    Nested classes/interfaces inherited from interface org.gradle.api.Named

    org.gradle.api.Named.Namer

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    NAME
    The name for the task, used by the extension when registering it.

    Fields inherited from class net.minecraftforge.gradleutils.shared.ToolExecBase

    defaultToolDir

    Fields inherited from interface org.gradle.api.Task

    TASK_ACTION, TASK_CONSTRUCTOR_ARGS, TASK_DEPENDS_ON, TASK_DESCRIPTION, TASK_GROUP, TASK_NAME, TASK_OVERWRITE, TASK_TYPE

  • Constructor Summary

    Constructors
    Constructor
    Description
    GenerateChangelog()
    Constructs a new task instance.

  • Method Summary

    Modifier and Type
    Method
    Description
    protected void
    addArguments()
     
    void
    exec()
     
    abstract org.gradle.api.provider.Property<Boolean>
    getBuildMarkdown()
    Whether to build the changelog in Markdown format.
    abstract org.gradle.api.file.RegularFileProperty
    getOutputFile()
    The output file for the changelog.
    protected abstract org.gradle.api.provider.Property<String>
    getProjectPath()
    The absolute path to the current project.
    abstract org.gradle.api.provider.Property<String>
    getProjectUrl()
    The project URL to use in the changelog.
    abstract org.gradle.api.provider.Property<String>
    getStart()
    The tag (or object ID) to start the changelog from.

    Methods inherited from class net.minecraftforge.gradleutils.shared.ToolExecBase

    argOnlyIf, argOnlyIf, args, args, args, getProblems, getProjectLayout

    Methods inherited from class org.gradle.api.tasks.JavaExec

    args, args, bootstrapClasspath, classpath, copyTo, copyTo, debugOptions, environment, environment, executable, getAllJvmArgs, getArgs, getArgumentProviders, getBootstrapClasspath, getClasspath, getCommandLine, getDebug, getDebugOptions, getDefaultCharacterEncoding, getEnableAssertions, getEnvironment, getErrorOutput, getExecActionFactory, getExecutable, getExecutionResult, getJavaLauncher, getJavaToolchainService, getJavaVersion, getJvmArgs, getJvmArgumentProviders, getJvmArguments, getMainClass, getMainModule, getMaxHeapSize, getMinHeapSize, getModularity, getObjectFactory, getPropertyFactory, getProviderFactory, getStandardInput, getStandardOutput, getSystemProperties, getWorkingDir, isIgnoreExitValue, jvmArgs, jvmArgs, setAllJvmArgs, setAllJvmArgs, setArgs, setArgs, setArgsString, setBootstrapClasspath, setClasspath, setDebug, setDefaultCharacterEncoding, setEnableAssertions, setEnvironment, setErrorOutput, setExecutable, setExecutable, setIgnoreExitValue, setJvmArgs, setJvmArgs, setMaxHeapSize, setMinHeapSize, setStandardInput, setStandardOutput, setSystemProperties, setWorkingDir, setWorkingDir, systemProperties, systemProperty, workingDir

    Methods inherited from class org.gradle.api.internal.ConventionTask

    conventionMapping, conventionMapping, getConventionMapping

    Methods inherited from class org.gradle.api.DefaultTask

    compareTo, configure, dependsOn, doFirst, doFirst, doFirst, doLast, doLast, doLast, finalizedBy, getActions, getAnt, getDependsOn, getDescription, getDestroyables, getDidWork, getEnabled, getExtensions, getFinalizedBy, getGroup, getInputs, getLocalState, getLogger, getLogging, getMustRunAfter, getName, getOutputs, getPath, getProject, getShouldRunAfter, getState, getTaskDependencies, getTemporaryDir, getTimeout, hasProperty, mustRunAfter, onlyIf, onlyIf, onlyIf, property, setActions, setDependsOn, setDescription, setDidWork, setEnabled, setFinalizedBy, setGroup, setMustRunAfter, setOnlyIf, setOnlyIf, setOnlyIf, setProperty, setShouldRunAfter, shouldRunAfter, usesService

    Methods inherited from class org.gradle.api.internal.AbstractTask

    acceptServiceReferences, appendParallelSafeAction, doNotTrackState, getAsDynamicObject, getIdentityPath, getImpliesSubProjects, getLifecycleDependencies, getOnlyIf, getReasonNotToTrackState, getReasonTaskIsIncompatibleWithConfigurationCache, getRequiredServices, getServices, getSharedResources, getStandardOutputCapture, getTaskActions, getTaskIdentity, getTemporaryDirFactory, hasTaskActions, injectIntoNewInstance, isCompatibleWithConfigurationCache, isEnabled, isHasCustomActions, notCompatibleWithConfigurationCache, prependParallelSafeAction, setImpliesSubProjects

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface org.gradle.api.Task

    doNotTrackState, notCompatibleWithConfigurationCache

  • Field Details

  • Constructor Details

    • GenerateChangelog

      @Inject public GenerateChangelog()
      Constructs a new task instance.

  • Method Details

    • getOutputFile

      @OutputFile public abstract org.gradle.api.file.RegularFileProperty getOutputFile()
      The output file for the changelog.
      Returns:
      A property for the output file

    • getProjectPath

      @Input protected abstract org.gradle.api.provider.Property<String> getProjectPath()

      The absolute path to the current project.

      Used to configure Git Version without needing to specify the directory itself, since using the directory itself can cause implicit dependencies on other tasks that use actually it.

      Returns:
      A property for the project path

    • getStart

      @Input @Optional public abstract org.gradle.api.provider.Property<String> getStart()
      The tag (or object ID) to start the changelog from.
      Returns:
      A property for the start tag

    • getProjectUrl

      @Input @Optional public abstract org.gradle.api.provider.Property<String> getProjectUrl()

      The project URL to use in the changelog.

      Git Version will automatically attempt to find a URL from the repository's remote details if left unspecified.

      Returns:
      A property for the project URL

    • getBuildMarkdown

      @Input public abstract org.gradle.api.provider.Property<Boolean> getBuildMarkdown()
      Whether to build the changelog in Markdown format.
      Returns:
      A property for Markdown formatting

    • addArguments

      protected void addArguments()
      Overrides:
      addArguments in class net.minecraftforge.gradleutils.shared.ToolExecBase<net.minecraftforge.gitversion.gradle.changelog.ChangelogProblems>

    • exec

      public void exec()
      Overrides:
      exec in class net.minecraftforge.gradleutils.shared.ToolExecBase<net.minecraftforge.gitversion.gradle.changelog.ChangelogProblems>