diff --git a/.github/workflows/ci-build.yml b/.github/workflows/ci-build.yml index 96604f0c..41b11332 100644 --- a/.github/workflows/ci-build.yml +++ b/.github/workflows/ci-build.yml @@ -99,6 +99,12 @@ jobs: id: build-pk-verify, run: 'mvn --batch-mode com.exasol:project-keeper-maven-plugin:verify --projects .' } + - name: Verify that metrics.json was created + id: verify-metrics-json + run: | + # Ensure that file exists: + ls -lh coverage-aggregator/target/metrics.json + cat coverage-aggregator/target/metrics.json - name: Verify Release Artifacts id: verify-release-artifacts run: "print_message() {\n local -r message=$1\n echo \"$message\"\n echo \"$message\" >> \"$GITHUB_STEP_SUMMARY\"\n}\n\nprint_message \"### Release Artifacts\"\n\nIFS=$'\\n' artifacts_array=($ARTIFACTS)\nmissing_files=()\nfor file in \"${artifacts_array[@]}\";\ndo \n echo \"Checking if file $file exists...\"\n if ! [[ -f \"$file\" ]]; then\n print_message \"* ⚠️ \\`$file\\` does not exist ⚠️\"\n echo \"Content of directory $(dirname \"$file\"):\"\n ls \"$(dirname \"$file\")\"\n missing_files+=(\"$file\")\n else\n print_message \"* \\`$file\\` ✅\" \n fi\ndone\nprint_message \"\"\nnumber_of_missing_files=${#missing_files[@]}\nif [[ $number_of_missing_files -gt 0 ]]; then\n print_message \"⚠️ $number_of_missing_files release artifact(s) missing ⚠️\"\n exit 1\nfi\n" diff --git a/.project-keeper.yml b/.project-keeper.yml index f5824200..9f0bd284 100644 --- a/.project-keeper.yml +++ b/.project-keeper.yml @@ -120,6 +120,15 @@ build: name: Run project-keeper itself id: build-pk-verify run: mvn --batch-mode com.exasol:project-keeper-maven-plugin:verify --projects . + - action: INSERT_AFTER + stepId: build-pk-verify + content: + name: Verify that metrics.json was created + id: verify-metrics-json + run: | + # Ensure that file exists: + ls -lh coverage-aggregator/target/metrics.json + cat coverage-aggregator/target/metrics.json # [itest->dsn~customize-build-process.dependency-check~0] - name: "dependencies_check.yml" diff --git a/coverage-aggregator/pom.xml b/coverage-aggregator/pom.xml new file mode 100644 index 00000000..41c3562c --- /dev/null +++ b/coverage-aggregator/pom.xml @@ -0,0 +1,98 @@ + + + 4.0.0 + com.exasol + coverage-aggregator + ${revision} + Project Keeper Coverage Aggregator + This module collects test coverage from all other modules and aggregates it into a single report. + + + com.exasol + project-keeper-parent-pom + ../parent-pom/pom.xml + ${revision} + + + + com.exasol + project-keeper-java-project-crawler + + + com.exasol + project-keeper-core + + + com.exasol + project-keeper-cli + ${revision} + + + com.exasol + project-keeper-maven-plugin + ${revision} + + + com.exasol + project-keeper-shared-model-classes + + + com.exasol + project-keeper-shared-test-setup + + + + + + org.jacoco + jacoco-maven-plugin + 0.8.12 + + + jacoco-site-aggregate + verify + + report-aggregate + + + + + + com.exasol + quality-summarizer-maven-plugin + 0.2.0 + + + summarize-metrics + + summarize + + + + + + org.apache.maven.plugins + maven-enforcer-plugin + 3.5.0 + + + enforce-maven + + enforce + + + + + 3.6.3 + + + 17 + + + + + + + + + diff --git a/dependencies.md b/dependencies.md index 2a7332bf..da0cae6e 100644 --- a/dependencies.md +++ b/dependencies.md @@ -61,8 +61,9 @@ | [Apache Maven Javadoc Plugin][46] | [Apache-2.0][1] | | [Nexus Staging Maven Plugin][47] | [Eclipse Public License][48] | | [JaCoCo :: Maven Plugin][49] | [EPL-2.0][50] | +| [Quality Summarizer Maven Plugin][51] | [MIT License][52] | | [error-code-crawler-maven-plugin][5] | [MIT License][6] | -| [Reproducible Build Maven Plugin][51] | [Apache 2.0][8] | +| [Reproducible Build Maven Plugin][53] | [Apache 2.0][8] | ## Project Keeper Core @@ -70,38 +71,38 @@ | Dependency | License | | ----------------------------------------- | --------------------------------------------- | -| [Project Keeper shared model classes][52] | [The MIT License][53] | -| [org.xmlunit:xmlunit-core][54] | [The Apache Software License, Version 2.0][8] | +| [Project Keeper shared model classes][54] | [The MIT License][55] | +| [org.xmlunit:xmlunit-core][56] | [The Apache Software License, Version 2.0][8] | | [error-reporting-java][16] | [MIT License][17] | -| [Markdown Generator][55] | [The Apache Software License, Version 2.0][8] | -| [semver4j][56] | [The MIT License][27] | -| [SnakeYAML][57] | [Apache License, Version 2.0][8] | -| [SnakeYAML Engine][58] | [Apache License, Version 2.0][8] | -| [Maven Model][59] | [Apache-2.0][1] | -| [jcabi-github][60] | [BSD][61] | +| [Markdown Generator][57] | [The Apache Software License, Version 2.0][8] | +| [semver4j][58] | [The MIT License][27] | +| [SnakeYAML][59] | [Apache License, Version 2.0][8] | +| [SnakeYAML Engine][60] | [Apache License, Version 2.0][8] | +| [Maven Model][61] | [Apache-2.0][1] | +| [jcabi-github][62] | [BSD][63] | ### Test Dependencies | Dependency | License | | ------------------------------------------ | --------------------------------------------- | -| [Project Keeper shared test setup][52] | [The MIT License][53] | -| [Maven Project Version Getter][62] | [MIT License][63] | +| [Project Keeper shared test setup][54] | [The MIT License][55] | +| [Maven Project Version Getter][64] | [MIT License][65] | | [JUnit Jupiter Engine][20] | [Eclipse Public License v2.0][21] | | [JUnit Jupiter Params][20] | [Eclipse Public License v2.0][21] | | [Hamcrest][22] | [BSD-3-Clause][23] | -| [org.xmlunit:xmlunit-matchers][54] | [The Apache Software License, Version 2.0][8] | +| [org.xmlunit:xmlunit-matchers][56] | [The Apache Software License, Version 2.0][8] | | [mockito-junit-jupiter][28] | [MIT][29] | -| [Maven Plugin Integration Testing][64] | [MIT License][65] | +| [Maven Plugin Integration Testing][66] | [MIT License][67] | | [EqualsVerifier \| release normal jar][25] | [Apache License, Version 2.0][1] | | [to-string-verifier][26] | [MIT License][27] | -| [junit-pioneer][66] | [Eclipse Public License v2.0][21] | +| [junit-pioneer][68] | [Eclipse Public License v2.0][21] | | [SLF4J JDK14 Provider][30] | [MIT License][27] | ### Runtime Dependencies | Dependency | License | | ----------------------------------------- | --------------------- | -| [Project Keeper Java project crawler][52] | [The MIT License][53] | +| [Project Keeper Java project crawler][54] | [The MIT License][55] | ### Plugin Dependencies @@ -113,7 +114,7 @@ | [Apache Maven Site Plugin][34] | [Apache License, Version 2.0][1] | | [SonarQube Scanner for Maven][35] | [GNU LGPL 3][36] | | [Apache Maven Toolchains Plugin][37] | [Apache-2.0][1] | -| [Apache Maven JAR Plugin][67] | [Apache-2.0][1] | +| [Apache Maven JAR Plugin][69] | [Apache-2.0][1] | | [Apache Maven Compiler Plugin][38] | [Apache-2.0][1] | | [Apache Maven Enforcer Plugin][0] | [Apache-2.0][1] | | [Maven Flatten Plugin][39] | [Apache Software Licenese][1] | @@ -126,10 +127,11 @@ | [Apache Maven Source Plugin][45] | [Apache License, Version 2.0][1] | | [Apache Maven Javadoc Plugin][46] | [Apache-2.0][1] | | [Nexus Staging Maven Plugin][47] | [Eclipse Public License][48] | -| [Maven Failsafe Plugin][68] | [Apache-2.0][1] | +| [Maven Failsafe Plugin][70] | [Apache-2.0][1] | | [JaCoCo :: Maven Plugin][49] | [EPL-2.0][50] | +| [Quality Summarizer Maven Plugin][51] | [MIT License][52] | | [error-code-crawler-maven-plugin][5] | [MIT License][6] | -| [Reproducible Build Maven Plugin][51] | [Apache 2.0][8] | +| [Reproducible Build Maven Plugin][53] | [Apache 2.0][8] | ## Project Keeper Command Line Interface @@ -137,19 +139,19 @@ | Dependency | License | | -------------------------- | --------------------- | -| [Project Keeper Core][52] | [The MIT License][53] | +| [Project Keeper Core][54] | [The MIT License][55] | | [error-reporting-java][16] | [MIT License][17] | -| [Maven Model][59] | [Apache-2.0][1] | +| [Maven Model][61] | [Apache-2.0][1] | ### Test Dependencies | Dependency | License | | -------------------------------------- | --------------------------------- | -| [Project Keeper shared test setup][52] | [The MIT License][53] | +| [Project Keeper shared test setup][54] | [The MIT License][55] | | [JUnit Jupiter Engine][20] | [Eclipse Public License v2.0][21] | | [JUnit Jupiter Params][20] | [Eclipse Public License v2.0][21] | | [Hamcrest][22] | [BSD-3-Clause][23] | -| [Maven Project Version Getter][62] | [MIT License][63] | +| [Maven Project Version Getter][64] | [MIT License][65] | ### Runtime Dependencies @@ -175,18 +177,19 @@ | [Maven Surefire Plugin][40] | [Apache-2.0][1] | | [Versions Maven Plugin][41] | [Apache License, Version 2.0][1] | | [duplicate-finder-maven-plugin Maven Mojo][42] | [Apache License 2.0][43] | -| [Apache Maven Assembly Plugin][69] | [Apache-2.0][1] | -| [Apache Maven JAR Plugin][67] | [Apache-2.0][1] | -| [Artifact reference checker and unifier][70] | [MIT License][71] | +| [Apache Maven Assembly Plugin][71] | [Apache-2.0][1] | +| [Apache Maven JAR Plugin][69] | [Apache-2.0][1] | +| [Artifact reference checker and unifier][72] | [MIT License][73] | | [Apache Maven Deploy Plugin][4] | [Apache-2.0][1] | | [Apache Maven GPG Plugin][44] | [Apache-2.0][1] | | [Apache Maven Source Plugin][45] | [Apache License, Version 2.0][1] | | [Apache Maven Javadoc Plugin][46] | [Apache-2.0][1] | | [Nexus Staging Maven Plugin][47] | [Eclipse Public License][48] | -| [Maven Failsafe Plugin][68] | [Apache-2.0][1] | +| [Maven Failsafe Plugin][70] | [Apache-2.0][1] | | [JaCoCo :: Maven Plugin][49] | [EPL-2.0][50] | +| [Quality Summarizer Maven Plugin][51] | [MIT License][52] | | [error-code-crawler-maven-plugin][5] | [MIT License][6] | -| [Reproducible Build Maven Plugin][51] | [Apache 2.0][8] | +| [Reproducible Build Maven Plugin][53] | [Apache 2.0][8] | ## Project Keeper Maven Plugin @@ -194,25 +197,25 @@ | Dependency | License | | ----------------------------------------- | --------------------- | -| [Project Keeper Core][52] | [The MIT License][53] | -| [Maven Plugin Tools Java Annotations][72] | [Apache-2.0][1] | -| [Maven Plugin API][73] | [Apache-2.0][1] | -| [Maven Core][74] | [Apache-2.0][1] | +| [Project Keeper Core][54] | [The MIT License][55] | +| [Maven Plugin Tools Java Annotations][74] | [Apache-2.0][1] | +| [Maven Plugin API][75] | [Apache-2.0][1] | +| [Maven Core][76] | [Apache-2.0][1] | | [error-reporting-java][16] | [MIT License][17] | ### Test Dependencies | Dependency | License | | -------------------------------------- | --------------------------------------------- | -| [Maven Project Version Getter][62] | [MIT License][63] | +| [Maven Project Version Getter][64] | [MIT License][65] | | [JUnit Jupiter Engine][20] | [Eclipse Public License v2.0][21] | | [JUnit Jupiter Params][20] | [Eclipse Public License v2.0][21] | | [Hamcrest][22] | [BSD-3-Clause][23] | -| [org.xmlunit:xmlunit-matchers][54] | [The Apache Software License, Version 2.0][8] | +| [org.xmlunit:xmlunit-matchers][56] | [The Apache Software License, Version 2.0][8] | | [mockito-core][28] | [MIT][29] | -| [Maven Plugin Integration Testing][64] | [MIT License][65] | +| [Maven Plugin Integration Testing][66] | [MIT License][67] | | [SLF4J JDK14 Provider][30] | [MIT License][27] | -| [JaCoCo :: Agent][75] | [EPL-2.0][50] | +| [JaCoCo :: Agent][77] | [EPL-2.0][50] | ### Plugin Dependencies @@ -224,25 +227,26 @@ | [Apache Maven Site Plugin][34] | [Apache License, Version 2.0][1] | | [SonarQube Scanner for Maven][35] | [GNU LGPL 3][36] | | [Apache Maven Toolchains Plugin][37] | [Apache-2.0][1] | -| [Maven Plugin Plugin][76] | [Apache-2.0][1] | +| [Maven Plugin Plugin][78] | [Apache-2.0][1] | | [Apache Maven Compiler Plugin][38] | [Apache-2.0][1] | | [Apache Maven Enforcer Plugin][0] | [Apache-2.0][1] | | [Maven Flatten Plugin][39] | [Apache Software Licenese][1] | | [org.sonatype.ossindex.maven:ossindex-maven-plugin][7] | [ASL2][8] | | [Maven Surefire Plugin][40] | [Apache-2.0][1] | | [Versions Maven Plugin][41] | [Apache License, Version 2.0][1] | -| [Apache Maven JAR Plugin][67] | [Apache-2.0][1] | +| [Apache Maven JAR Plugin][69] | [Apache-2.0][1] | | [duplicate-finder-maven-plugin Maven Mojo][42] | [Apache License 2.0][43] | | [Apache Maven Deploy Plugin][4] | [Apache-2.0][1] | | [Apache Maven GPG Plugin][44] | [Apache-2.0][1] | | [Apache Maven Source Plugin][45] | [Apache License, Version 2.0][1] | | [Apache Maven Javadoc Plugin][46] | [Apache-2.0][1] | | [Nexus Staging Maven Plugin][47] | [Eclipse Public License][48] | -| [Apache Maven Dependency Plugin][77] | [Apache-2.0][1] | -| [Maven Failsafe Plugin][68] | [Apache-2.0][1] | +| [Apache Maven Dependency Plugin][79] | [Apache-2.0][1] | +| [Maven Failsafe Plugin][70] | [Apache-2.0][1] | | [JaCoCo :: Maven Plugin][49] | [EPL-2.0][50] | +| [Quality Summarizer Maven Plugin][51] | [MIT License][52] | | [error-code-crawler-maven-plugin][5] | [MIT License][6] | -| [Reproducible Build Maven Plugin][51] | [Apache 2.0][8] | +| [Reproducible Build Maven Plugin][53] | [Apache 2.0][8] | ## Project Keeper Java Project Crawler @@ -250,28 +254,28 @@ | Dependency | License | | ----------------------------------------- | --------------------- | -| [Project Keeper shared model classes][52] | [The MIT License][53] | -| [Maven Plugin Tools Java Annotations][72] | [Apache-2.0][1] | -| [Maven Plugin API][73] | [Apache-2.0][1] | +| [Project Keeper shared model classes][54] | [The MIT License][55] | +| [Maven Plugin Tools Java Annotations][74] | [Apache-2.0][1] | +| [Maven Plugin API][75] | [Apache-2.0][1] | | [error-reporting-java][16] | [MIT License][17] | | [JGit - Core][18] | [BSD-3-Clause][19] | -| [semver4j][56] | [The MIT License][27] | -| [Maven Core][74] | [Apache-2.0][1] | +| [semver4j][58] | [The MIT License][27] | +| [Maven Core][76] | [Apache-2.0][1] | ### Test Dependencies | Dependency | License | | -------------------------------------- | --------------------------------------------- | -| [Maven Project Version Getter][62] | [MIT License][63] | +| [Maven Project Version Getter][64] | [MIT License][65] | | [JUnit Jupiter Engine][20] | [Eclipse Public License v2.0][21] | | [JUnit Jupiter Params][20] | [Eclipse Public License v2.0][21] | | [Hamcrest][22] | [BSD-3-Clause][23] | -| [org.xmlunit:xmlunit-matchers][54] | [The Apache Software License, Version 2.0][8] | +| [org.xmlunit:xmlunit-matchers][56] | [The Apache Software License, Version 2.0][8] | | [SLF4J JDK14 Provider][30] | [MIT License][27] | | [mockito-core][28] | [MIT][29] | | [mockito-junit-jupiter][28] | [MIT][29] | -| [Maven Plugin Integration Testing][64] | [MIT License][65] | -| [JaCoCo :: Agent][75] | [EPL-2.0][50] | +| [Maven Plugin Integration Testing][66] | [MIT License][67] | +| [JaCoCo :: Agent][77] | [EPL-2.0][50] | ### Plugin Dependencies @@ -289,18 +293,19 @@ | [org.sonatype.ossindex.maven:ossindex-maven-plugin][7] | [ASL2][8] | | [Maven Surefire Plugin][40] | [Apache-2.0][1] | | [Versions Maven Plugin][41] | [Apache License, Version 2.0][1] | -| [Maven Plugin Plugin][76] | [Apache-2.0][1] | +| [Maven Plugin Plugin][78] | [Apache-2.0][1] | | [duplicate-finder-maven-plugin Maven Mojo][42] | [Apache License 2.0][43] | | [Apache Maven Deploy Plugin][4] | [Apache-2.0][1] | | [Apache Maven GPG Plugin][44] | [Apache-2.0][1] | | [Apache Maven Source Plugin][45] | [Apache License, Version 2.0][1] | | [Apache Maven Javadoc Plugin][46] | [Apache-2.0][1] | | [Nexus Staging Maven Plugin][47] | [Eclipse Public License][48] | -| [Apache Maven Dependency Plugin][77] | [Apache-2.0][1] | -| [Maven Failsafe Plugin][68] | [Apache-2.0][1] | +| [Apache Maven Dependency Plugin][79] | [Apache-2.0][1] | +| [Maven Failsafe Plugin][70] | [Apache-2.0][1] | | [JaCoCo :: Maven Plugin][49] | [EPL-2.0][50] | +| [Quality Summarizer Maven Plugin][51] | [MIT License][52] | | [error-code-crawler-maven-plugin][5] | [MIT License][6] | -| [Reproducible Build Maven Plugin][51] | [Apache 2.0][8] | +| [Reproducible Build Maven Plugin][53] | [Apache 2.0][8] | ## Project Keeper Shared Test Setup @@ -308,10 +313,10 @@ | Dependency | License | | ----------------------------------------- | -------------------------------- | -| [Project Keeper shared model classes][52] | [The MIT License][53] | -| [SnakeYAML][57] | [Apache License, Version 2.0][8] | +| [Project Keeper shared model classes][54] | [The MIT License][55] | +| [SnakeYAML][59] | [Apache License, Version 2.0][8] | | [Hamcrest][22] | [BSD-3-Clause][23] | -| [Maven Model][59] | [Apache-2.0][1] | +| [Maven Model][61] | [Apache-2.0][1] | ### Plugin Dependencies @@ -331,8 +336,9 @@ | [Versions Maven Plugin][41] | [Apache License, Version 2.0][1] | | [duplicate-finder-maven-plugin Maven Mojo][42] | [Apache License 2.0][43] | | [JaCoCo :: Maven Plugin][49] | [EPL-2.0][50] | +| [Quality Summarizer Maven Plugin][51] | [MIT License][52] | | [error-code-crawler-maven-plugin][5] | [MIT License][6] | -| [Reproducible Build Maven Plugin][51] | [Apache 2.0][8] | +| [Reproducible Build Maven Plugin][53] | [Apache 2.0][8] | [0]: https://maven.apache.org/enforcer/maven-enforcer-plugin/ [1]: https://www.apache.org/licenses/LICENSE-2.0.txt @@ -385,30 +391,32 @@ [48]: http://www.eclipse.org/legal/epl-v10.html [49]: https://www.jacoco.org/jacoco/trunk/doc/maven.html [50]: https://www.eclipse.org/legal/epl-2.0/ -[51]: http://zlika.github.io/reproducible-build-maven-plugin -[52]: https://github.com/exasol/project-keeper/ -[53]: https://github.com/exasol/project-keeper/blob/main/LICENSE -[54]: https://www.xmlunit.org/ -[55]: https://github.com/Steppschuh/Java-Markdown-Generator -[56]: https://github.com/vdurmont/semver4j -[57]: https://bitbucket.org/snakeyaml/snakeyaml -[58]: https://bitbucket.org/snakeyaml/snakeyaml-engine -[59]: https://maven.apache.org/ref/3.9.9/maven-model/ -[60]: https://www.jcabi.com/jcabi-github -[61]: https://www.jcabi.com/LICENSE.txt -[62]: https://github.com/exasol/maven-project-version-getter/ -[63]: https://github.com/exasol/maven-project-version-getter/blob/main/LICENSE -[64]: https://github.com/exasol/maven-plugin-integration-testing/ -[65]: https://github.com/exasol/maven-plugin-integration-testing/blob/main/LICENSE -[66]: https://junit-pioneer.org/ -[67]: https://maven.apache.org/plugins/maven-jar-plugin/ -[68]: https://maven.apache.org/surefire/maven-failsafe-plugin/ -[69]: https://maven.apache.org/plugins/maven-assembly-plugin/ -[70]: https://github.com/exasol/artifact-reference-checker-maven-plugin/ -[71]: https://github.com/exasol/artifact-reference-checker-maven-plugin/blob/main/LICENSE -[72]: https://maven.apache.org/plugin-tools/maven-plugin-annotations -[73]: https://maven.apache.org/ref/3.9.9/maven-plugin-api/ -[74]: https://maven.apache.org/ref/3.9.9/maven-core/ -[75]: https://www.eclemma.org/jacoco/index.html -[76]: https://maven.apache.org/plugin-tools/maven-plugin-plugin -[77]: https://maven.apache.org/plugins/maven-dependency-plugin/ +[51]: https://github.com/exasol/quality-summarizer-maven-plugin/ +[52]: https://github.com/exasol/quality-summarizer-maven-plugin/blob/main/LICENSE +[53]: http://zlika.github.io/reproducible-build-maven-plugin +[54]: https://github.com/exasol/project-keeper/ +[55]: https://github.com/exasol/project-keeper/blob/main/LICENSE +[56]: https://www.xmlunit.org/ +[57]: https://github.com/Steppschuh/Java-Markdown-Generator +[58]: https://github.com/vdurmont/semver4j +[59]: https://bitbucket.org/snakeyaml/snakeyaml +[60]: https://bitbucket.org/snakeyaml/snakeyaml-engine +[61]: https://maven.apache.org/ref/3.9.9/maven-model/ +[62]: https://www.jcabi.com/jcabi-github +[63]: https://www.jcabi.com/LICENSE.txt +[64]: https://github.com/exasol/maven-project-version-getter/ +[65]: https://github.com/exasol/maven-project-version-getter/blob/main/LICENSE +[66]: https://github.com/exasol/maven-plugin-integration-testing/ +[67]: https://github.com/exasol/maven-plugin-integration-testing/blob/main/LICENSE +[68]: https://junit-pioneer.org/ +[69]: https://maven.apache.org/plugins/maven-jar-plugin/ +[70]: https://maven.apache.org/surefire/maven-failsafe-plugin/ +[71]: https://maven.apache.org/plugins/maven-assembly-plugin/ +[72]: https://github.com/exasol/artifact-reference-checker-maven-plugin/ +[73]: https://github.com/exasol/artifact-reference-checker-maven-plugin/blob/main/LICENSE +[74]: https://maven.apache.org/plugin-tools/maven-plugin-annotations +[75]: https://maven.apache.org/ref/3.9.9/maven-plugin-api/ +[76]: https://maven.apache.org/ref/3.9.9/maven-core/ +[77]: https://www.eclemma.org/jacoco/index.html +[78]: https://maven.apache.org/plugin-tools/maven-plugin-plugin +[79]: https://maven.apache.org/plugins/maven-dependency-plugin/ diff --git a/doc/changes/changelog.md b/doc/changes/changelog.md index e08afa3a..4bdd59bf 100644 --- a/doc/changes/changelog.md +++ b/doc/changes/changelog.md @@ -1,6 +1,6 @@ # Changes -* [4.3.4](changes_4.3.4.md) +* [4.4.0](changes_4.4.0.md) * [4.3.3](changes_4.3.3.md) * [4.3.2](changes_4.3.2.md) * [4.3.1](changes_4.3.1.md) diff --git a/doc/changes/changes_4.3.4.md b/doc/changes/changes_4.4.0.md similarity index 91% rename from doc/changes/changes_4.3.4.md rename to doc/changes/changes_4.4.0.md index f7b07130..bc9b0d4e 100644 --- a/doc/changes/changes_4.3.4.md +++ b/doc/changes/changes_4.4.0.md @@ -1,4 +1,4 @@ -# Project Keeper 4.3.4, released 2024-??-?? +# Project Keeper 4.4.0, released 2024-10-23 Code name: Fix vulnerabilities @@ -8,7 +8,9 @@ This release fixes vulnerability CVE-2024-47554 in transitive test dependency `c The release ignores vulnerability CVE-2023-7272 in transitive runtime dependency `org.glassfish:javax.json:1.1.4` via `com.jcabi:jcabi-github:jar:1.9.1` as this is accepted for accessing exasol json documents on GitHub. -The release also pins Maven plugin versions to avoid plugin versions depending on the Maven version. +The release also pins Maven plugin versions to avoid verify findings caused by differences in plugin versions that only depend on the Maven version. + +The release also adds `quality-summarizer-maven-plugin` to the generated parent pom. The release also installs the Java versions required by Maven sources during the CI builds. Just set property `java.version` in your `pom.xml` and the required JDK will be installed in all GitHub workflows. See the [user guide](../user_guide/user_guide.md#jdk-toolchain-version) for details. @@ -22,6 +24,10 @@ The release also installs the Java versions required by Maven sources during the * #587: Fixed vulnerability CVE-2024-47554 in test dependency `commons-io:commons-io:2.13.0` * #588: Ignore vulnerability CVE-2023-7272 in runtime dependency `org.glassfish:javax.json:1.1.4` +### Features + +* #513: Added `quality-summarizer-maven-plugin` to the generated parent POM + ### Bugfixes * #585: Pinned Maven plugin versions in generated parent pom @@ -29,7 +35,7 @@ The release also installs the Java versions required by Maven sources during the ### Documentation -* #582: Documented automatic release process in user guide +* #582: Documented automated release process in user guide ## Dependency Updates @@ -60,6 +66,7 @@ The release also installs the Java versions required by Maven sources during the #### Plugin Dependency Updates +* Added `com.exasol:quality-summarizer-maven-plugin:0.2.0` * Updated `io.github.zlika:reproducible-build-maven-plugin:0.16` to `0.17` * Updated `org.apache.maven.plugins:maven-clean-plugin:2.5` to `3.4.0` * Updated `org.apache.maven.plugins:maven-gpg-plugin:3.2.4` to `3.2.7` @@ -74,19 +81,19 @@ The release also installs the Java versions required by Maven sources during the #### Compile Dependency Updates -* Updated `com.exasol:project-keeper-shared-model-classes:4.3.3` to `4.3.4` +* Updated `com.exasol:project-keeper-shared-model-classes:4.3.3` to `4.4.0` * Updated `com.jcabi:jcabi-github:1.8.0` to `1.9.1` * Updated `org.snakeyaml:snakeyaml-engine:2.7` to `2.8` * Updated `org.yaml:snakeyaml:2.2` to `2.3` #### Runtime Dependency Updates -* Updated `com.exasol:project-keeper-java-project-crawler:4.3.3` to `4.3.4` +* Updated `com.exasol:project-keeper-java-project-crawler:4.3.3` to `4.4.0` #### Test Dependency Updates * Updated `com.exasol:maven-plugin-integration-testing:1.1.2` to `1.1.3` -* Updated `com.exasol:project-keeper-shared-test-setup:4.3.3` to `4.3.4` +* Updated `com.exasol:project-keeper-shared-test-setup:4.3.3` to `4.4.0` * Updated `nl.jqno.equalsverifier:equalsverifier:3.16.1` to `3.17.1` * Updated `org.hamcrest:hamcrest:2.2` to `3.0` * Updated `org.junit-pioneer:junit-pioneer:2.2.0` to `2.3.0` @@ -97,6 +104,7 @@ The release also installs the Java versions required by Maven sources during the #### Plugin Dependency Updates +* Added `com.exasol:quality-summarizer-maven-plugin:0.2.0` * Updated `io.github.zlika:reproducible-build-maven-plugin:0.16` to `0.17` * Updated `org.apache.maven.plugins:maven-clean-plugin:2.5` to `3.4.0` * Updated `org.apache.maven.plugins:maven-failsafe-plugin:3.2.5` to `3.5.1` @@ -113,7 +121,7 @@ The release also installs the Java versions required by Maven sources during the #### Compile Dependency Updates -* Updated `com.exasol:project-keeper-core:4.3.3` to `4.3.4` +* Updated `com.exasol:project-keeper-core:4.3.3` to `4.4.0` * Updated `org.apache.maven:maven-model:3.9.7` to `3.9.9` #### Runtime Dependency Updates @@ -123,13 +131,14 @@ The release also installs the Java versions required by Maven sources during the #### Test Dependency Updates -* Updated `com.exasol:project-keeper-shared-test-setup:4.3.3` to `4.3.4` +* Updated `com.exasol:project-keeper-shared-test-setup:4.3.3` to `4.4.0` * Updated `org.hamcrest:hamcrest:2.2` to `3.0` * Updated `org.junit.jupiter:junit-jupiter-engine:5.10.2` to `5.11.3` * Updated `org.junit.jupiter:junit-jupiter-params:5.10.2` to `5.11.3` #### Plugin Dependency Updates +* Added `com.exasol:quality-summarizer-maven-plugin:0.2.0` * Updated `io.github.zlika:reproducible-build-maven-plugin:0.16` to `0.17` * Updated `org.apache.maven.plugins:maven-clean-plugin:2.5` to `3.4.0` * Updated `org.apache.maven.plugins:maven-failsafe-plugin:3.2.5` to `3.5.1` @@ -146,7 +155,7 @@ The release also installs the Java versions required by Maven sources during the #### Compile Dependency Updates -* Updated `com.exasol:project-keeper-core:4.3.3` to `4.3.4` +* Updated `com.exasol:project-keeper-core:4.3.3` to `4.4.0` #### Test Dependency Updates @@ -159,6 +168,7 @@ The release also installs the Java versions required by Maven sources during the #### Plugin Dependency Updates +* Added `com.exasol:quality-summarizer-maven-plugin:0.2.0` * Updated `io.github.zlika:reproducible-build-maven-plugin:0.16` to `0.17` * Updated `org.apache.maven.plugins:maven-clean-plugin:2.5` to `3.4.0` * Updated `org.apache.maven.plugins:maven-dependency-plugin:3.6.1` to `3.8.0` @@ -176,7 +186,7 @@ The release also installs the Java versions required by Maven sources during the #### Compile Dependency Updates -* Updated `com.exasol:project-keeper-shared-model-classes:4.3.3` to `4.3.4` +* Updated `com.exasol:project-keeper-shared-model-classes:4.3.3` to `4.4.0` * Updated `org.eclipse.jgit:org.eclipse.jgit:6.7.0.202309050840-r` to `7.0.0.202409031743-r` #### Test Dependency Updates @@ -191,6 +201,7 @@ The release also installs the Java versions required by Maven sources during the #### Plugin Dependency Updates +* Added `com.exasol:quality-summarizer-maven-plugin:0.2.0` * Updated `io.github.zlika:reproducible-build-maven-plugin:0.16` to `0.17` * Updated `org.apache.maven.plugins:maven-clean-plugin:2.5` to `3.4.0` * Updated `org.apache.maven.plugins:maven-dependency-plugin:3.6.1` to `3.8.0` @@ -208,12 +219,13 @@ The release also installs the Java versions required by Maven sources during the #### Compile Dependency Updates -* Updated `com.exasol:project-keeper-shared-model-classes:4.3.3` to `4.3.4` +* Updated `com.exasol:project-keeper-shared-model-classes:4.3.3` to `4.4.0` * Updated `org.hamcrest:hamcrest:2.2` to `3.0` * Updated `org.yaml:snakeyaml:2.2` to `2.3` #### Plugin Dependency Updates +* Added `com.exasol:quality-summarizer-maven-plugin:0.2.0` * Updated `io.github.zlika:reproducible-build-maven-plugin:0.16` to `0.17` * Updated `org.apache.maven.plugins:maven-clean-plugin:2.5` to `3.4.0` * Updated `org.apache.maven.plugins:maven-install-plugin:2.4` to `3.1.3` diff --git a/doc/user_guide/user_guide.md b/doc/user_guide/user_guide.md index 83b6187c..6f9cbfb9 100644 --- a/doc/user_guide/user_guide.md +++ b/doc/user_guide/user_guide.md @@ -503,7 +503,7 @@ The standalone variant supports the same goals as the Maven plugin: `fix`, `veri GitHub Workflow [`release.yml`](#releaseyml) will automatically release the project when `ci-build.yml` succeeded on `main` branch and the changes file contains an up-to-date release date. In case of problems you can start the workflow manually on GitHub and skip the release to Maven Central or GitHub if necessary. -To check if a project meets all preconditions for an automatic release, run PK goal `verify-release`: +To check if a project meets all preconditions for an automated release, run PK goal `verify-release`: ```sh # Maven diff --git a/maven-project-crawler/.settings/org.eclipse.jdt.core.prefs b/maven-project-crawler/.settings/org.eclipse.jdt.core.prefs index f75b1646..21a6d8e7 100644 --- a/maven-project-crawler/.settings/org.eclipse.jdt.core.prefs +++ b/maven-project-crawler/.settings/org.eclipse.jdt.core.prefs @@ -120,7 +120,7 @@ org.eclipse.jdt.core.compiler.problem.unusedTypeParameter=ignore org.eclipse.jdt.core.compiler.problem.unusedWarningToken=warning org.eclipse.jdt.core.compiler.problem.varargsArgumentNeedCast=warning org.eclipse.jdt.core.compiler.processAnnotations=disabled -org.eclipse.jdt.core.compiler.release=enabled +org.eclipse.jdt.core.compiler.release=disabled org.eclipse.jdt.core.compiler.source=17 org.eclipse.jdt.core.formatter.align_assignment_statements_on_columns=false org.eclipse.jdt.core.formatter.align_fields_grouping_blank_lines=2147483647 diff --git a/maven-project-crawler/pk_generated_parent.pom b/maven-project-crawler/pk_generated_parent.pom index 9c998903..eed13553 100644 --- a/maven-project-crawler/pk_generated_parent.pom +++ b/maven-project-crawler/pk_generated_parent.pom @@ -421,6 +421,19 @@ + + com.exasol + quality-summarizer-maven-plugin + 0.2.0 + + + summarize-metrics + + summarize + + + + com.exasol error-code-crawler-maven-plugin diff --git a/parent-pom/pom.xml b/parent-pom/pom.xml index 75707ff1..b77148ca 100644 --- a/parent-pom/pom.xml +++ b/parent-pom/pom.xml @@ -28,7 +28,7 @@ - 4.3.4 + 4.4.0 17 3.9.9 diff --git a/pom.xml b/pom.xml index b32ca99b..7936bdf5 100644 --- a/pom.xml +++ b/pom.xml @@ -19,6 +19,7 @@ maven-project-crawler project-keeper-maven-plugin parent-pom + coverage-aggregator diff --git a/project-keeper-cli/.settings/org.eclipse.jdt.core.prefs b/project-keeper-cli/.settings/org.eclipse.jdt.core.prefs index f75b1646..21a6d8e7 100644 --- a/project-keeper-cli/.settings/org.eclipse.jdt.core.prefs +++ b/project-keeper-cli/.settings/org.eclipse.jdt.core.prefs @@ -120,7 +120,7 @@ org.eclipse.jdt.core.compiler.problem.unusedTypeParameter=ignore org.eclipse.jdt.core.compiler.problem.unusedWarningToken=warning org.eclipse.jdt.core.compiler.problem.varargsArgumentNeedCast=warning org.eclipse.jdt.core.compiler.processAnnotations=disabled -org.eclipse.jdt.core.compiler.release=enabled +org.eclipse.jdt.core.compiler.release=disabled org.eclipse.jdt.core.compiler.source=17 org.eclipse.jdt.core.formatter.align_assignment_statements_on_columns=false org.eclipse.jdt.core.formatter.align_fields_grouping_blank_lines=2147483647 diff --git a/project-keeper-cli/pk_generated_parent.pom b/project-keeper-cli/pk_generated_parent.pom index e77d99ce..9e019bc1 100644 --- a/project-keeper-cli/pk_generated_parent.pom +++ b/project-keeper-cli/pk_generated_parent.pom @@ -435,6 +435,19 @@ + + com.exasol + quality-summarizer-maven-plugin + 0.2.0 + + + summarize-metrics + + summarize + + + + com.exasol error-code-crawler-maven-plugin diff --git a/project-keeper-maven-plugin/.settings/org.eclipse.jdt.core.prefs b/project-keeper-maven-plugin/.settings/org.eclipse.jdt.core.prefs index f75b1646..21a6d8e7 100644 --- a/project-keeper-maven-plugin/.settings/org.eclipse.jdt.core.prefs +++ b/project-keeper-maven-plugin/.settings/org.eclipse.jdt.core.prefs @@ -120,7 +120,7 @@ org.eclipse.jdt.core.compiler.problem.unusedTypeParameter=ignore org.eclipse.jdt.core.compiler.problem.unusedWarningToken=warning org.eclipse.jdt.core.compiler.problem.varargsArgumentNeedCast=warning org.eclipse.jdt.core.compiler.processAnnotations=disabled -org.eclipse.jdt.core.compiler.release=enabled +org.eclipse.jdt.core.compiler.release=disabled org.eclipse.jdt.core.compiler.source=17 org.eclipse.jdt.core.formatter.align_assignment_statements_on_columns=false org.eclipse.jdt.core.formatter.align_fields_grouping_blank_lines=2147483647 diff --git a/project-keeper-maven-plugin/pk_generated_parent.pom b/project-keeper-maven-plugin/pk_generated_parent.pom index 0825ebf4..4ceb61cc 100644 --- a/project-keeper-maven-plugin/pk_generated_parent.pom +++ b/project-keeper-maven-plugin/pk_generated_parent.pom @@ -421,6 +421,19 @@ + + com.exasol + quality-summarizer-maven-plugin + 0.2.0 + + + summarize-metrics + + summarize + + + + com.exasol error-code-crawler-maven-plugin diff --git a/project-keeper/.settings/org.eclipse.jdt.core.prefs b/project-keeper/.settings/org.eclipse.jdt.core.prefs index f75b1646..21a6d8e7 100644 --- a/project-keeper/.settings/org.eclipse.jdt.core.prefs +++ b/project-keeper/.settings/org.eclipse.jdt.core.prefs @@ -120,7 +120,7 @@ org.eclipse.jdt.core.compiler.problem.unusedTypeParameter=ignore org.eclipse.jdt.core.compiler.problem.unusedWarningToken=warning org.eclipse.jdt.core.compiler.problem.varargsArgumentNeedCast=warning org.eclipse.jdt.core.compiler.processAnnotations=disabled -org.eclipse.jdt.core.compiler.release=enabled +org.eclipse.jdt.core.compiler.release=disabled org.eclipse.jdt.core.compiler.source=17 org.eclipse.jdt.core.formatter.align_assignment_statements_on_columns=false org.eclipse.jdt.core.formatter.align_fields_grouping_blank_lines=2147483647 diff --git a/project-keeper/pk_generated_parent.pom b/project-keeper/pk_generated_parent.pom index bb080be1..12ae6b98 100644 --- a/project-keeper/pk_generated_parent.pom +++ b/project-keeper/pk_generated_parent.pom @@ -385,6 +385,19 @@ + + com.exasol + quality-summarizer-maven-plugin + 0.2.0 + + + summarize-metrics + + summarize + + + + com.exasol error-code-crawler-maven-plugin diff --git a/project-keeper/src/main/java/com/exasol/projectkeeper/validators/pom/PomFileGenerator.java b/project-keeper/src/main/java/com/exasol/projectkeeper/validators/pom/PomFileGenerator.java index d7f2302a..1adb6bd4 100644 --- a/project-keeper/src/main/java/com/exasol/projectkeeper/validators/pom/PomFileGenerator.java +++ b/project-keeper/src/main/java/com/exasol/projectkeeper/validators/pom/PomFileGenerator.java @@ -56,6 +56,8 @@ public class PomFileGenerator { new SimplePluginTemplateGenerator("maven_templates/native-image-maven-plugin.xml", NATIVE_IMAGE), new SimplePluginTemplateGenerator("maven_templates/lombok-maven-plugin.xml", LOMBOK), new FailsafePluginTemplateGenerator(), new JacocoPluginTemplateGenerator(), + // quality-summarizer-maven-plugin must come after Jacoco + new SimplePluginTemplateGenerator("maven_templates/quality-summarizer-maven-plugin.xml", DEFAULT), new ErrorCodeCrawlerPluginTemplateGenerator(), // Reproducible build plugin must be last new SimplePluginTemplateGenerator("maven_templates/reproducible-build-maven-plugin.xml", DEFAULT)); diff --git a/project-keeper/src/main/resources/maven_templates/quality-summarizer-maven-plugin.xml b/project-keeper/src/main/resources/maven_templates/quality-summarizer-maven-plugin.xml new file mode 100644 index 00000000..12ec8640 --- /dev/null +++ b/project-keeper/src/main/resources/maven_templates/quality-summarizer-maven-plugin.xml @@ -0,0 +1,13 @@ + + com.exasol + quality-summarizer-maven-plugin + 0.2.0 + + + summarize-metrics + + summarize + + + + diff --git a/project-keeper/src/main/resources/templates/.settings/org.eclipse.jdt.core.prefs b/project-keeper/src/main/resources/templates/.settings/org.eclipse.jdt.core.prefs index a2f2bb92..e7f28f86 100644 --- a/project-keeper/src/main/resources/templates/.settings/org.eclipse.jdt.core.prefs +++ b/project-keeper/src/main/resources/templates/.settings/org.eclipse.jdt.core.prefs @@ -120,7 +120,7 @@ org.eclipse.jdt.core.compiler.problem.unusedTypeParameter=ignore org.eclipse.jdt.core.compiler.problem.unusedWarningToken=warning org.eclipse.jdt.core.compiler.problem.varargsArgumentNeedCast=warning org.eclipse.jdt.core.compiler.processAnnotations=disabled -org.eclipse.jdt.core.compiler.release=enabled +org.eclipse.jdt.core.compiler.release=disabled org.eclipse.jdt.core.compiler.source=$javaVersion org.eclipse.jdt.core.formatter.align_assignment_statements_on_columns=false org.eclipse.jdt.core.formatter.align_fields_grouping_blank_lines=2147483647 diff --git a/project-keeper/src/test/java/com/exasol/projectkeeper/validators/pom/PomFileGeneratorTest.java b/project-keeper/src/test/java/com/exasol/projectkeeper/validators/pom/PomFileGeneratorTest.java index 30f48916..981c2c56 100644 --- a/project-keeper/src/test/java/com/exasol/projectkeeper/validators/pom/PomFileGeneratorTest.java +++ b/project-keeper/src/test/java/com/exasol/projectkeeper/validators/pom/PomFileGeneratorTest.java @@ -72,7 +72,7 @@ void testGenerateWithDefaultModule() { "maven-surefire-plugin", "versions-maven-plugin", "jacoco-maven-plugin", "error-code-crawler-maven-plugin", "duplicate-finder-maven-plugin", "maven-toolchains-plugin", "maven-clean-plugin", "maven-install-plugin", - "maven-resources-plugin", "maven-site-plugin"))); + "maven-resources-plugin", "maven-site-plugin", "quality-summarizer-maven-plugin"))); } static Stream testPluginsAddedByModuleCases() { diff --git a/shared-model-classes/.settings/org.eclipse.jdt.core.prefs b/shared-model-classes/.settings/org.eclipse.jdt.core.prefs index f75b1646..21a6d8e7 100644 --- a/shared-model-classes/.settings/org.eclipse.jdt.core.prefs +++ b/shared-model-classes/.settings/org.eclipse.jdt.core.prefs @@ -120,7 +120,7 @@ org.eclipse.jdt.core.compiler.problem.unusedTypeParameter=ignore org.eclipse.jdt.core.compiler.problem.unusedWarningToken=warning org.eclipse.jdt.core.compiler.problem.varargsArgumentNeedCast=warning org.eclipse.jdt.core.compiler.processAnnotations=disabled -org.eclipse.jdt.core.compiler.release=enabled +org.eclipse.jdt.core.compiler.release=disabled org.eclipse.jdt.core.compiler.source=17 org.eclipse.jdt.core.formatter.align_assignment_statements_on_columns=false org.eclipse.jdt.core.formatter.align_fields_grouping_blank_lines=2147483647 diff --git a/shared-model-classes/pk_generated_parent.pom b/shared-model-classes/pk_generated_parent.pom index e865577d..95b4d559 100644 --- a/shared-model-classes/pk_generated_parent.pom +++ b/shared-model-classes/pk_generated_parent.pom @@ -365,6 +365,19 @@ + + com.exasol + quality-summarizer-maven-plugin + 0.2.0 + + + summarize-metrics + + summarize + + + + com.exasol error-code-crawler-maven-plugin diff --git a/shared-model-classes/pom.xml b/shared-model-classes/pom.xml index dc60c585..702e7273 100644 --- a/shared-model-classes/pom.xml +++ b/shared-model-classes/pom.xml @@ -1,15 +1,15 @@ + Classes that need to be shared between different modules of project-keeper. + 4.0.0 + project-keeper-shared-model-classes + Project Keeper shared model classes ./pk_generated_parent.pom com.exasol project-keeper-shared-model-classes-generated-parent ${revision} - Classes that need to be shared between different modules of project-keeper. - 4.0.0 - project-keeper-shared-model-classes - Project Keeper shared model classes jakarta.json diff --git a/shared-test-setup/.settings/org.eclipse.jdt.core.prefs b/shared-test-setup/.settings/org.eclipse.jdt.core.prefs index f75b1646..21a6d8e7 100644 --- a/shared-test-setup/.settings/org.eclipse.jdt.core.prefs +++ b/shared-test-setup/.settings/org.eclipse.jdt.core.prefs @@ -120,7 +120,7 @@ org.eclipse.jdt.core.compiler.problem.unusedTypeParameter=ignore org.eclipse.jdt.core.compiler.problem.unusedWarningToken=warning org.eclipse.jdt.core.compiler.problem.varargsArgumentNeedCast=warning org.eclipse.jdt.core.compiler.processAnnotations=disabled -org.eclipse.jdt.core.compiler.release=enabled +org.eclipse.jdt.core.compiler.release=disabled org.eclipse.jdt.core.compiler.source=17 org.eclipse.jdt.core.formatter.align_assignment_statements_on_columns=false org.eclipse.jdt.core.formatter.align_fields_grouping_blank_lines=2147483647 diff --git a/shared-test-setup/pk_generated_parent.pom b/shared-test-setup/pk_generated_parent.pom index 391200a8..7f23d6cc 100644 --- a/shared-test-setup/pk_generated_parent.pom +++ b/shared-test-setup/pk_generated_parent.pom @@ -267,6 +267,19 @@ + + com.exasol + quality-summarizer-maven-plugin + 0.2.0 + + + summarize-metrics + + summarize + + + + com.exasol error-code-crawler-maven-plugin