This is an automated email from the ASF dual-hosted git repository. mdedetrich pushed a commit to branch 1.3.x in repository https://gitbox.apache.org/repos/asf/pekko.git
commit 691d1c6474b455b30951719b2d49e62c6ce560d5 Author: Matthew de Detrich <[email protected]> AuthorDate: Tue Oct 21 11:03:09 2025 +0200 Revert manual disabling of sbt-license-report (cherry picked from commit 3bb3291ab769675e51fd062bfeb86d128c55e8e5) --- .github/workflows/link-validator.yml | 2 +- .github/workflows/publish-1.0-docs.yml | 2 +- .github/workflows/publish-1.0-nightly.yml | 2 +- .github/workflows/publish-1.1-docs.yml | 2 +- .github/workflows/publish-1.1-nightly.yml | 2 +- .github/workflows/publish-1.2-docs.yml | 2 +- .github/workflows/publish-nightly.yml | 2 +- CONTRIBUTING.md | 12 ---- build.sbt | 1 - docs/src/main/paradox/index.md | 2 +- .../paradox/project/{project-index.md => index.md} | 2 +- project/Paradox.scala | 7 +- project/PekkoBuild.scala | 5 +- project/ProjectIndexGenerator.scala | 74 ---------------------- 14 files changed, 14 insertions(+), 103 deletions(-) diff --git a/.github/workflows/link-validator.yml b/.github/workflows/link-validator.yml index 8fb337b19f..0eb7310c38 100644 --- 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 index 1cabeba8ba..a8d1bb7c7f 100644 --- 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 index 07446c8836..fdaf620656 100644 --- 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 index 7dfcfa0385..d79c999700 100644 --- 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 index eda0d37b59..d06a54a09e 100644 --- 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 index e54575fa52..31396fc986 100644 --- 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 index c53782b4e6..4d436cea47 100644 --- 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 index 3f0a2d0d6c..e26806f085 100644 --- 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 index 6fbffc068e..ae85048522 100644 --- 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 index 1f6a2417b6..94eff25305 100644 --- 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/project-index.md b/docs/src/main/paradox/project/index.md similarity index 83% rename from docs/src/main/paradox/project/project-index.md rename to docs/src/main/paradox/project/index.md index ad073d3a20..0d8b1ce3ca 100644 --- a/docs/src/main/paradox/project/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 index 26dd9c83fa..5e8515ad59 100644 --- 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 index 50d04d0ca5..7b258bd215 100644 --- 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 deleted file mode 100644 index 4443328e34..0000000000 --- a/project/ProjectIndexGenerator.scala +++ /dev/null @@ -1,74 +0,0 @@ -/* - * Licensed to the Apache Software Foundation (ASF) under one or more - * contributor license agreements. See the NOTICE file distributed with - * this work for additional information regarding copyright ownership. - * The ASF licenses this file to You under the Apache License, Version 2.0 - * (the "License"); you may not use this file except in compliance with - * the License. You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -import sbt._ -import Keys._ - -object ProjectIndexGenerator extends AutoPlugin { - - object CliOptions { - val generateLicenseReportEnabled = CliOption("pekko.genlicensereport.enabled", false) - } - - override val projectSettings: Seq[Setting[_]] = inConfig(Compile)( - Seq( - resourceGenerators += - generateIndex(sourceDirectory, _ / "paradox" / "project" / "project-index.md"))) - - def generateIndex(dir: SettingKey[File], locate: File => File) = Def.task[Seq[File]] { - val file = locate(dir.value) - - val markdownFilesBeforeLicense = Seq( - "../common/binary-compatibility-rules.md", - "scala3.md", - "downstream-upgrade-strategy.md", - "../common/may-change.md", - "../additional/ide.md", - "immutable.md", - "../additional/osgi.md", - "rolling-update.md", - "issue-tracking.md", - "licenses.md") - val markdownFilesAfterLicense = Seq( - "../additional/faq.md", - "../additional/books.md", - "examples.md", - "links.md") - - val markdownFiles = if (CliOptions.generateLicenseReportEnabled.get) { - markdownFilesBeforeLicense ++ Seq("license-report.md") ++ markdownFilesAfterLicense - } else { - markdownFilesBeforeLicense ++ markdownFilesAfterLicense - } - - val content = - s"""<!-- DO NOT EDIT DIRECTLY: This file is generated by `project/ProjectIndexGenerator`. See CONTRIBUTING.md for details. --> - |# Project Information - | - |@@toc { depth=2 } - | - |@@@ index - | - |${markdownFiles.map(f => s"* [${f.replace(".md", "")}]($f)").mkString("\n")} - | - |@@@ - |""".stripMargin - - if (!file.exists || IO.read(file) != content) IO.write(file, content) - Seq(file) - } -} --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
