changelog.publishAll no longer affects subprojects by default

Publishing the changelog to subprojects can still be done this way:

```groovy
changelog {
    fromBase()
    publishAll = true
    includeSubprojects = true // NEW!
}
```

The only projects I believe need this are Forge and Bootstrap.

Author: Jonathing

.gitversion.toml

@@ -0,0 +1,3 @@
+[gradlePlugin]
+path = "gradle-plugin"
+tag = "gradle"

gradle-plugin/changelog-gradle/build.gradle

@@ -59,7 +59,6 @@ dependencies {
 }
 
 // Removes local Gradle API from compileOnly. This is a workaround for bugged plugins.
-// TODO [GradleUtils][GradleAPI] Remove this once they are fixed.
 // Publish Plugin: https://github.com/gradle/plugin-portal-requests/issues/260
 // Shadow:         https://github.com/GradleUp/shadow/pull/1422
 afterEvaluate { project ->

gradle-plugin/changelog-gradle/src/main/groovy/net/minecraftforge/gitversion/gradle/changelog/ChangelogExtension.java

@@ -44,9 +44,17 @@ public sealed interface ChangelogExtension permits ChangelogExtensionInternal {
 
     /// The property that sets if the changelog generation should be enabled for all maven publications in the project.
     ///
-    /// It will also set up publishing for all subprojects as long as that subproject does not have another changelog
+    /// @apiNote To set up publishing for all subprojects,  as long as that subproject does not have another changelog
     /// plugin overriding the propagation.
     ///
     /// @return The property for if the changelog generation is enabled for all maven publications
     Property<Boolean> getPublishAll();
+
+    /// If [publishing all][#getPublishAll()], 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.
+    ///
+    /// @return The property for if the changelog generation for publishing to all should include subprojects
+    Property<Boolean> getIncludeSubprojects();
 }

gradle-plugin/changelog-gradle/src/main/groovy/net/minecraftforge/gitversion/gradle/changelog/ChangelogExtensionImpl.groovy

@@ -6,7 +6,6 @@ package net.minecraftforge.gitversion.gradle.changelog
 
 import groovy.transform.CompileStatic
 import groovy.transform.PackageScope
-import groovy.transform.PackageScopeTarget
 import org.gradle.api.Project
 import org.gradle.api.model.ObjectFactory
 import org.gradle.api.provider.Property
@@ -17,11 +16,11 @@ import org.gradle.api.tasks.TaskProvider
 import javax.inject.Inject
 
 @CompileStatic
-@PackageScope([PackageScopeTarget.CLASS, PackageScopeTarget.FIELDS])
-abstract class ChangelogExtensionImpl implements ChangelogExtensionInternal {
+@PackageScope abstract class ChangelogExtensionImpl implements ChangelogExtensionInternal {
     private final Project project
 
     private final Property<Boolean> publishingAll
+    private final Property<Boolean> includingSubprojects
     private final Property<Boolean> isGenerating
 
     private @Lazy TaskProvider<? extends GenerateChangelog> task = {
@@ -38,12 +37,13 @@ abstract class ChangelogExtensionImpl implements ChangelogExtensionInternal {
         this.project = project
 
         this.publishingAll = this.objects.property(Boolean).convention(false)
+        this.includingSubprojects = this.objects.property(Boolean).convention(false)
         this.isGenerating = this.objects.property(Boolean).convention(false)
     }
 
     private void finish(Project project) {
-        if (this.publishAll.getOrElse(false))
-            ChangelogUtils.setupChangelogGenerationOnAllPublishTasks(project)
+        if (this.publishingAll.getOrElse(false))
+            ChangelogUtils.setupChangelogGenerationOnAllPublishTasks(project, this.includingSubprojects)
     }
 
     @Override
@@ -71,22 +71,25 @@ abstract class ChangelogExtensionImpl implements ChangelogExtensionInternal {
         this.publishingAll
     }
 
+    @Override
+    Property<Boolean> getIncludeSubprojects() {
+        this.includingSubprojects
+    }
+
     @Override
     boolean isGenerating() {
         this.isGenerating.get()
     }
 
     @Override
-    TaskProvider<CopyChangelog> copyTo(Project project) {
+    TaskProvider<? extends CopyChangelog> copyTo(Project project) {
         // isGenerating = true and afterEvaluate ensured
         // See ChangelogUtils#setupChangelogGenerationForPublishingAfterEvaluation
-        project.tasks.register(CopyChangelog.NAME, CopyChangelog) { task ->
+        project.tasks.register(CopyChangelog.NAME, CopyChangelogImpl) { task ->
             task.dependsOn(this.task)
 
             var dependency = project.dependencies.project('path': this.project.path, 'configuration': GenerateChangelog.NAME)
-            var configuration = project.configurations.detachedConfiguration(dependency).tap {
-                it.canBeConsumed = false
-            }
+            var configuration = project.configurations.detachedConfiguration(dependency).tap { canBeConsumed = false }
             task.inputFile.fileProvider(project.providers.provider(configuration.&getSingleFile))
         }
     }

gradle-plugin/changelog-gradle/src/main/groovy/net/minecraftforge/gitversion/gradle/changelog/ChangelogExtensionInternal.java

@@ -17,5 +17,5 @@ default TypeOf<?> getPublicType() {
 
     boolean isGenerating();
 
-    TaskProvider<CopyChangelog> copyTo(Project project);
+    TaskProvider<? extends CopyChangelog> copyTo(Project project);
 }

gradle-plugin/changelog-gradle/src/main/groovy/net/minecraftforge/gitversion/gradle/changelog/ChangelogUtils.groovy

@@ -9,11 +9,10 @@ import groovy.transform.PackageScope
 import groovy.transform.PackageScopeTarget
 import org.gradle.api.Project
 import org.gradle.api.Task
-import org.gradle.api.file.FileCollection
+import org.gradle.api.provider.Property
 import org.gradle.api.publish.PublishingExtension
 import org.gradle.api.publish.maven.MavenArtifact
 import org.gradle.api.publish.maven.MavenPublication
-import org.gradle.api.tasks.TaskOutputs
 import org.gradle.api.tasks.TaskProvider
 import org.gradle.language.base.plugins.LifecycleBasePlugin
 import org.jetbrains.annotations.Nullable
@@ -48,22 +47,24 @@ class ChangelogUtils {
      *
      * @param project The project to add changelog generation publishing to
      */
-    static void setupChangelogGenerationOnAllPublishTasks(Project project) {
+    static void setupChangelogGenerationOnAllPublishTasks(Project project, Property<Boolean> includingSubprojects) {
         setupChangelogGenerationForAllPublications(project)
 
-        project.subprojects {
-            Util.ensureAfterEvaluate(it) { subproject ->
-                // attempt to get the current subproject's changelog extension
-                var changelog = subproject.extensions.findByType(ChangelogExtension)
+        if (includingSubprojects.getOrElse(false)) {
+            project.subprojects {
+                Util.ensureAfterEvaluate(it) { subproject ->
+                    // attempt to get the current subproject's changelog extension
+                    @Nullable var changelog = subproject.extensions.findByType(ChangelogExtension)
 
-                // find the changelog extension for the highest project that has it, if the subproject doesn't
-                for (var parent = project; changelog === null && parent !== null; parent = parent.parent == parent ? null : parent.parent) {
-                    changelog = parent.extensions.findByType(ChangelogExtension)
-                }
+                    // find the changelog extension for the highest project that has it, if the subproject doesn't
+                    for (var parent = project; changelog === null && parent !== null; parent = parent.parent == parent ? null : parent.parent) {
+                        changelog = parent.extensions.findByType(ChangelogExtension)
+                    }
 
-                // if the project with changelog is publishing all changelogs, set up changelogs for the subproject
-                if (changelog?.publishAll?.getOrElse(false))
-                    setupChangelogGenerationForAllPublications(subproject)
+                    // if the project with changelog is publishing all changelogs, set up changelogs for the subproject
+                    if (changelog?.publishAll?.getOrElse(false))
+                        setupChangelogGenerationForAllPublications(subproject)
+                }
             }
         }
     }

gradle-plugin/changelog-gradle/src/main/groovy/net/minecraftforge/gitversion/gradle/changelog/CopyChangelog.java

@@ -4,67 +4,10 @@
  */
 package net.minecraftforge.gitversion.gradle.changelog;
 
-import org.gradle.api.DefaultTask;
-import org.gradle.api.file.ProjectLayout;
-import org.gradle.api.file.RegularFileProperty;
-import org.gradle.api.provider.ProviderFactory;
-import org.gradle.api.reflect.HasPublicType;
-import org.gradle.api.reflect.TypeOf;
-import org.gradle.api.tasks.InputFile;
-import org.gradle.api.tasks.Internal;
-import org.gradle.api.tasks.OutputFile;
-import org.gradle.api.tasks.TaskAction;
+import org.gradle.api.Task;
 
-import javax.inject.Inject;
-import java.io.File;
-import java.io.IOException;
-import java.nio.file.Files;
-
-// This task class is internal. Do NOT attempt to use it directly.
-// If you need the output, use `project.tasks.named('copyChangelog').outputs.files` instead
-abstract class CopyChangelog extends DefaultTask implements HasPublicType {
-    static final String NAME = "copyChangelog";
-
-    protected abstract @Inject ProviderFactory getProviders();
-
-    @Inject
-    public CopyChangelog(ProjectLayout layout) {
-        this.setDescription("Copies a changelog file to this project's build directory.");
-
-        this.getOutputFile().convention(layout.getBuildDirectory().file("changelog.txt"));
-    }
-
-    @Override
-    public @Internal TypeOf<?> getPublicType() {
-        return TypeOf.typeOf(DefaultTask.class);
-    }
-
-    public abstract @OutputFile RegularFileProperty getOutputFile();
-
-    public abstract @InputFile RegularFileProperty getInputFile();
-
-    @TaskAction
-    public void exec() {
-        byte[] input;
-        try {
-            // ProviderFactory#fileContents so Gradle is aware of our usage of the input
-            input = this.getProviders().fileContents(this.getInputFile()).getAsBytes().get();
-        } catch (IllegalStateException e) {
-            throw new RuntimeException(e);
-        }
-
-        File output = this.getOutputFile().get().getAsFile();
-
-        if (!output.getParentFile().exists() && !output.getParentFile().mkdirs())
-            throw new IllegalStateException();
-
-        try {
-            Files.write(
-                output.toPath(),
-                input
-            );
-        } catch (IOException e) {
-            throw new RuntimeException(e);
-        }
-    }
+/// Copies a changelog from a parent project to this subproject.
+public sealed interface CopyChangelog extends Task permits CopyChangelogInternal {
+    /// The name for this task.
+    String NAME = "copyChangelog";
 }

gradle-plugin/changelog-gradle/src/main/groovy/net/minecraftforge/gitversion/gradle/changelog/CopyChangelogImpl.groovy

@@ -0,0 +1,42 @@
+/*
+ * Copyright (c) Forge Development LLC
+ * SPDX-License-Identifier: LGPL-2.1-only
+ */
+package net.minecraftforge.gitversion.gradle.changelog
+
+import groovy.transform.CompileStatic
+import groovy.transform.PackageScope
+import groovy.transform.PackageScopeTarget
+import org.gradle.api.DefaultTask
+import org.gradle.api.file.RegularFileProperty
+import org.gradle.api.provider.ProviderFactory
+import org.gradle.api.tasks.InputFile
+import org.gradle.api.tasks.OutputFile
+import org.gradle.api.tasks.TaskAction
+
+import javax.inject.Inject
+
+// This task class is internal. Do NOT attempt to use it directly.
+// If you need the output, use `project.tasks.named('copyChangelog').outputs.files` instead
+@CompileStatic
+@PackageScope abstract class CopyChangelogImpl extends DefaultTask implements CopyChangelogInternal {
+    protected abstract @Inject ProviderFactory getProviders()
+
+    @Inject
+    CopyChangelogImpl() {
+        this.description = 'Copies a changelog file to this project\'s build directory.'
+
+        this.outputFile.convention(this.getDefaultOutputFile('txt'))
+    }
+
+    protected abstract @InputFile RegularFileProperty getInputFile()
+    protected abstract @OutputFile RegularFileProperty getOutputFile()
+
+    @TaskAction
+    void exec() {
+        var input = this.providers.fileContents(this.inputFile).asBytes.get()
+        var output = this.outputFile.asFile.get()
+
+        output.bytes = input
+    }
+}

gradle-plugin/changelog-gradle/src/main/groovy/net/minecraftforge/gitversion/gradle/changelog/CopyChangelogInternal.java

@@ -0,0 +1,24 @@
+/*
+ * Copyright (c) Forge Development LLC
+ * SPDX-License-Identifier: LGPL-2.1-only
+ */
+package net.minecraftforge.gitversion.gradle.changelog;
+
+import net.minecraftforge.gradleutils.shared.EnhancedPlugin;
+import net.minecraftforge.gradleutils.shared.EnhancedTask;
+import org.gradle.api.Project;
+import org.gradle.api.reflect.HasPublicType;
+import org.gradle.api.reflect.TypeOf;
+import org.gradle.api.tasks.Internal;
+
+non-sealed interface CopyChangelogInternal extends CopyChangelog, EnhancedTask, HasPublicType {
+    @Override
+    default Class<? extends EnhancedPlugin<? super Project>> pluginType() {
+        return ChangelogPlugin.class;
+    }
+
+    @Override
+    default @Internal TypeOf<?> getPublicType() {
+        return TypeOf.typeOf(CopyChangelog.class);
+    }
+}

gradle-plugin/common/build.gradle

@@ -12,6 +12,9 @@ dependencies {
     // Static Analysis
     compileOnly libs.nulls
 
+    // Gradle
+    compileOnly libs.gradle
+
     // GradleUtils
     implementation libs.gradleutils.shared
 }