Add library name to documentation task

Author: eyuan-netflix

nebula-archrules-gradle-plugin/src/main/java/com/netflix/nebula/archrules/gradle/GenerateDocsParams.java

@@ -12,4 +12,6 @@ public interface GenerateDocsParams extends WorkParameters {
     ListProperty<String> getOwnArchRulesClasses();
 
     Property<File> getOutputFile();
+
+    Property<String> getLibraryName();
 }

nebula-archrules-gradle-plugin/src/main/java/com/netflix/nebula/archrules/gradle/GenerateDocsWorkAction.java

@@ -37,18 +37,19 @@ public void execute() {
         });
 
         var output = getParameters().getOutputFile().get();
+        var libraryName = getParameters().getLibraryName().get();
         output.getParentFile().mkdirs();
         try {
-            Files.writeString(output.toPath(), formatMarkdown(rules));
+            Files.writeString(output.toPath(), formatMarkdown(rules, libraryName));
         } catch (IOException e) {
             throw new RuntimeException(e);
         }
     }
 
-    private String formatMarkdown(List<RuleMetadata> rules) {
+    private String formatMarkdown(List<RuleMetadata> rules, String libraryName) {
         var str = new StringBuilder();
         str.append("# ArchRules Documentation\n\n");
-        str.append("List of all archrules defined in this library.\n\n");
+        str.append("List of all archrules defined in `").append(libraryName).append("`.\n\n");
 
         var sortedRules = rules.stream().sorted(Comparator.comparing(r -> r.ruleName)).toList();
         sortedRules.forEach(rule -> {

nebula-archrules-gradle-plugin/src/main/kotlin/com/netflix/nebula/archrules/gradle/ArchrulesLibraryPlugin.kt

@@ -81,6 +81,7 @@ class ArchrulesLibraryPlugin : Plugin<Project> {
                 outputFile.convention(
                     project.layout.buildDirectory.file("docs/archrules.md")
                 )
+                libraryName.convention(project.name)
                 dependsOn(generateServicesTask)
             }
             registerRuntimeFeatureForSourceSet(project, archRulesSourceSet, jarTask)

nebula-archrules-gradle-plugin/src/main/kotlin/com/netflix/nebula/archrules/gradle/GenerateRulesDocumentationTask.kt

@@ -3,8 +3,10 @@ package com.netflix.nebula.archrules.gradle
 import org.gradle.api.DefaultTask
 import org.gradle.api.file.ConfigurableFileCollection
 import org.gradle.api.file.RegularFileProperty
+import org.gradle.api.provider.Property
 import org.gradle.api.tasks.CacheableTask
 import org.gradle.api.tasks.Classpath
+import org.gradle.api.tasks.Input
 import org.gradle.api.tasks.OutputFile
 import org.gradle.api.tasks.TaskAction
 import org.gradle.kotlin.dsl.submit
@@ -22,6 +24,9 @@ abstract class GenerateRulesDocumentationTask @Inject constructor(private val wo
     @get:OutputFile
     abstract val outputFile: RegularFileProperty
 
+    @get:Input
+    abstract val libraryName: Property<String>
+
     @TaskAction
     fun generateDocs() {
         val ownArchRulesClasses = rulesClasspath.files.map {
@@ -43,6 +48,7 @@ abstract class GenerateRulesDocumentationTask @Inject constructor(private val wo
         workQueue.submit(GenerateDocsWorkAction::class) {
             getOwnArchRulesClasses().set(ownArchRulesClasses)
             getOutputFile().set(this@GenerateRulesDocumentationTask.outputFile.get().asFile)
+            getLibraryName().set(this@GenerateRulesDocumentationTask.libraryName.get())
         }
     }
 }

nebula-archrules-gradle-plugin/src/test/kotlin/com/netflix/nebula/archrules/gradle/ArchrulesLibraryPluginTest.kt

@@ -391,6 +391,7 @@ class ArchrulesLibraryPluginTest {
 
         assertThat(docsFile.readText())
             .contains("# ArchRules Documentation")
+            .contains("List of all archrules defined in `archrules-library`.")
             .contains("## deprecated\n" +
                 "\n" +
                 "**Description:** No code should reference deprecated APIs, because usage of deprecated APIs introduces risk that future upgrades and migrations will be blocked\n" +