Revert manual disabling of sbt-license-report

mdedetrich · mdedetrich · commit 1cf8b207b90b · 2025-10-21T14:31:35.000+02:00
(cherry picked from commit 3bb3291)
diff --git a/.github/workflows/link-validator.yml b/.github/workflows/link-validator.yml
@@ -49,7 +49,7 @@ jobs:
           DEVELOCITY_ACCESS_KEY: ${{ secrets.DEVELOCITY_ACCESS_KEY }}
         run: |-
           cp .jvmopts-ci .jvmopts
-          sbt -Dpekko.genjavadoc.enabled=true -Dpekko.genlicensereport.enabled=true "Javaunidoc/doc; Compile/unidoc; docs/paradox"
+          sbt -Dpekko.genjavadoc.enabled=true "Javaunidoc/doc; Compile/unidoc; docs/paradox"
 
       - name: Run Link Validator
         run: cs launch net.runne::site-link-validator:0.2.4 -- scripts/link-validator.conf
diff --git a/.github/workflows/publish-1.0-docs.yml b/.github/workflows/publish-1.0-docs.yml
@@ -60,7 +60,7 @@ jobs:
         env:
           DEVELOCITY_ACCESS_KEY: ${{ secrets.DEVELOCITY_ACCESS_KEY }}
         run: |-
-          sbt -Dpekko.genjavadoc.enabled=true -Dpekko.genlicensereport.enabled=true "set ThisBuild / version := \"1.0.3\"; docs/paradox; unidoc"
+          sbt -Dpekko.genjavadoc.enabled=true "set ThisBuild / version := \"1.0.3\"; docs/paradox; unidoc"
 
       # Create directory structure upfront since rsync does not create intermediate directories otherwise
       - name: Create directory structure
diff --git a/.github/workflows/publish-1.0-nightly.yml b/.github/workflows/publish-1.0-nightly.yml
@@ -70,4 +70,4 @@ jobs:
 
       - name: Build Documentation
         run: |-
-          sbt -Dpekko.genjavadoc.enabled=true -Dpekko.genlicensereport.enabled=true docs/paradox unidoc
+          sbt -Dpekko.genjavadoc.enabled=true docs/paradox unidoc
diff --git a/.github/workflows/publish-1.1-docs.yml b/.github/workflows/publish-1.1-docs.yml
@@ -60,7 +60,7 @@ jobs:
         env:
           DEVELOCITY_ACCESS_KEY: ${{ secrets.DEVELOCITY_ACCESS_KEY }}
         run: |-
-          sbt -Dpekko.genjavadoc.enabled=true -Dpekko.genlicensereport.enabled=true "set ThisBuild / version := \"1.1.5\"; docs/paradox; unidoc"
+          sbt -Dpekko.genjavadoc.enabled=true "set ThisBuild / version := \"1.1.5\"; docs/paradox; unidoc"
 
       # Create directory structure upfront since rsync does not create intermediate directories otherwise
       - name: Create directory structure
diff --git a/.github/workflows/publish-1.1-nightly.yml b/.github/workflows/publish-1.1-nightly.yml
@@ -70,4 +70,4 @@ jobs:
 
       - name: Build Documentation
         run: |-
-          sbt -Dpekko.genjavadoc.enabled=true -Dpekko.genlicensereport.enabled=true docs/paradox unidoc
+          sbt -Dpekko.genjavadoc.enabled=true docs/paradox unidoc
diff --git a/.github/workflows/publish-1.2-docs.yml b/.github/workflows/publish-1.2-docs.yml
@@ -59,7 +59,7 @@ jobs:
         env:
           DEVELOCITY_ACCESS_KEY: ${{ secrets.DEVELOCITY_ACCESS_KEY }}
         run: |-
-          sbt -Dpekko.genjavadoc.enabled=true -Dpekko.genlicensereport.enabled=true "set ThisBuild / version := \"1.2.1\"; docs/paradox; unidoc"
+          sbt -Dpekko.genjavadoc.enabled=true "set ThisBuild / version := \"1.2.1\"; docs/paradox; unidoc"
 
       # Create directory structure upfront since rsync does not create intermediate directories otherwise
       - name: Create directory structure
diff --git a/.github/workflows/publish-nightly.yml b/.github/workflows/publish-nightly.yml
@@ -69,7 +69,7 @@ jobs:
 
       - name: Build Documentation
         run: |-
-          sbt -Dpekko.genjavadoc.enabled=true -Dpekko.genlicensereport.enabled=true docs/paradox unidoc
+          sbt -Dpekko.genjavadoc.enabled=true docs/paradox unidoc
 
       # Create directory structure upfront since rsync does not create intermediate directories otherwise
       - name: Create nightly directory structure
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -348,18 +348,6 @@ sbt -Dpekko.genjavadoc.enabled=true Javaunidoc/doc
 
 Which will generate JavaDoc style docs in `./target/javaunidoc/index.html`. This requires a JDK version 11 or later.
 
-#### Changing the project information page index
-
-In case you want to change the index of `Project Information` page, you need to change it on the
-`project/ProjectIndexGenerator.scala` so it can be included in the automatic docs generation.
-
-#### License Report Generation
-
-By default, license report generation is disabled to improve compilation speed. You can enable it by configuring `-Dpekko.genlicensereport.enabled=true`. e.g.:
-
-- `sbt -Dpekko.genlicensereport.enabled=true "docs/paradox"`
-- `sbt -Dpekko.genlicensereport.enabled=true shell` And then `docs/paradox`
-
 ### External dependencies
 
 All the external runtime dependencies for the project, including transitive dependencies, must have an open source license that is equal to, or compatible with, [Apache 2](https://www.apache.org/licenses/LICENSE-2.0).
diff --git a/build.sbt b/build.sbt
@@ -247,7 +247,6 @@ lazy val docs = pekkoModule("docs")
     PekkoParadoxPlugin,
     NoPublish,
     ParadoxBrowse,
-    ProjectIndexGenerator,
     ScaladocNoVerificationOfDiagrams,
     StreamOperatorsIndexGenerator,
     Jdk9)
diff --git a/docs/src/main/paradox/index.md b/docs/src/main/paradox/index.md
@@ -17,7 +17,7 @@
 * [index-utilities](index-utilities.md)
 * [common/other-modules](common/other-modules.md)
 * [additional/deploy](additional/deploy.md)
-* [project/index](project/project-index.md)
+* [project/index](project/index.md)
 * [classic](index-classic.md)
 * [migration](migration/index.md)
 
diff --git a/docs/src/main/paradox/project/index.md b/docs/src/main/paradox/project/index.md
@@ -1,4 +1,3 @@
-<!-- DO NOT EDIT DIRECTLY: This file is generated by `project/ProjectIndexGenerator`. See CONTRIBUTING.md for details. -->
 # Project Information
 
 @@toc { depth=2 }
@@ -15,6 +14,7 @@
 * [rolling-update](rolling-update.md)
 * [issue-tracking](issue-tracking.md)
 * [licenses](licenses.md)
+* [license-report](license-report.md)
 * [../additional/faq](../additional/faq.md)
 * [../additional/books](../additional/books.md)
 * [examples](examples.md)
diff --git a/project/Paradox.scala b/project/Paradox.scala
@@ -95,10 +95,9 @@ object Paradox {
   lazy val sourceGeneratorSettings = Seq(
     Compile / paradoxMarkdownToHtml / sourceGenerators += Def.taskDyn {
       val targetFile = (Compile / paradox / sourceManaged).value / "project" / "license-report.md"
-      ProjectIndexGenerator.CliOptions.generateLicenseReportEnabled.ifTrue(
-        (LocalRootProject / dumpLicenseReportAggregate).map { dir =>
-          IO.copy(List(dir / "pekko-root-licenses.md" -> targetFile)).toList
-        }).orElse(Some(Def.task(List.empty[File]))).get
+      (LocalRootProject / dumpLicenseReportAggregate).map { dir =>
+        IO.copy(List(dir / "pekko-root-licenses.md" -> targetFile)).toList
+      }
     }.taskValue)
 
   lazy val settings =
diff --git a/project/PekkoBuild.scala b/project/PekkoBuild.scala
@@ -300,9 +300,8 @@ object PekkoBuild {
         UsefulTask("sortImports", "Sort the imports"),
         UsefulTask("mimaReportBinaryIssues ", "Check binary issues"),
         UsefulTask("validatePullRequest ", "Validate pull request"),
-        UsefulTask("docs/paradox", "Build documentation (license report will be generate on CI or Publish)"),
-        UsefulTask("docs/paradoxBrowse",
-          "Browse the generated documentation (license report will be generate on CI or Publish)"),
+        UsefulTask("docs/paradox", "Build documentation"),
+        UsefulTask("docs/paradoxBrowse", "Browse the generated documentation"),
         UsefulTask("tips:", "prefix commands with `+` to run against cross Scala versions."),
         UsefulTask("Contributing guide:", "https://github.com/apache/pekko/blob/main/CONTRIBUTING.md")).map(
         _.noAlias))
diff --git a/project/ProjectIndexGenerator.scala b/project/ProjectIndexGenerator.scala
