You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pekko.apache.org by md...@apache.org on 2025/10/21 10:05:56 UTC
(pekko) branch main updated: Revert manual disabling of sbt-license-report
This is an automated email from the ASF dual-hosted git repository.
mdedetrich pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/pekko.git
The following commit(s) were added to refs/heads/main by this push:
new 3bb3291ab7 Revert manual disabling of sbt-license-report
3bb3291ab7 is described below
commit 3bb3291ab769675e51fd062bfeb86d128c55e8e5
Author: Matthew de Detrich <md...@gmail.com>
AuthorDate: Tue Oct 21 11:03:09 2025 +0200
Revert manual disabling of sbt-license-report
---
.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-1.2-nightly.yml | 2 +-
.github/workflows/publish-1.3-nightly.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 ----------------------
16 files changed, 16 insertions(+), 105 deletions(-)
diff --git a/.github/workflows/link-validator.yml b/.github/workflows/link-validator.yml
index b01db14216..818d915868 100644
--- a/.github/workflows/link-validator.yml
+++ b/.github/workflows/link-validator.yml
@@ -51,7 +51,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 b84395923c..9650562a94 100644
--- a/.github/workflows/publish-1.0-docs.yml
+++ b/.github/workflows/publish-1.0-docs.yml
@@ -61,7 +61,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 4ac8b6f5d4..fd3d5ba4be 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 fe402ac01a..f8531edd69 100644
--- a/.github/workflows/publish-1.1-docs.yml
+++ b/.github/workflows/publish-1.1-docs.yml
@@ -61,7 +61,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 59669667b9..8c6c932975 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 b97d4ad055..4767817335 100644
--- a/.github/workflows/publish-1.2-docs.yml
+++ b/.github/workflows/publish-1.2-docs.yml
@@ -61,7 +61,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-1.2-nightly.yml b/.github/workflows/publish-1.2-nightly.yml
index ce97ff9a16..c80d26af6d 100644
--- a/.github/workflows/publish-1.2-nightly.yml
+++ b/.github/workflows/publish-1.2-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.3-nightly.yml b/.github/workflows/publish-1.3-nightly.yml
index f0c9f9e23d..3086013d63 100644
--- a/.github/workflows/publish-1.3-nightly.yml
+++ b/.github/workflows/publish-1.3-nightly.yml
@@ -71,4 +71,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-nightly.yml b/.github/workflows/publish-nightly.yml
index c6d85fba8c..29b1ee55c5 100644
--- a/.github/workflows/publish-nightly.yml
+++ b/.github/workflows/publish-nightly.yml
@@ -70,7 +70,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 d9295b6aad..fef6f7dcf5 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -351,18 +351,6 @@ sbt -Dpekko.genjavadoc.enabled=true Javaunidoc/doc
Which will generate JavaDoc style docs in `./target/javaunidoc/index.html`. This requires a JDK version 17 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 f1bc92a1c2..83a7d3cb1d 100644
--- a/build.sbt
+++ b/build.sbt
@@ -241,7 +241,6 @@ lazy val docs = pekkoModule("docs")
PekkoParadoxPlugin,
NoPublish,
ParadoxBrowse,
- ProjectIndexGenerator,
ScaladocNoVerificationOfDiagrams,
StreamOperatorsIndexGenerator)
.disablePlugins(MimaPlugin)
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 c315a8f9d9..2b69b3f914 100644
--- a/project/PekkoBuild.scala
+++ b/project/PekkoBuild.scala
@@ -281,9 +281,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: commits-unsubscribe@pekko.apache.org
For additional commands, e-mail: commits-help@pekko.apache.org