From 0469a81d85291f4dce7b93de4e2271c38ccab947 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Herv=C3=A9=20Boutemy?= Date: Wed, 17 Jan 2024 09:07:01 +0100 Subject: [PATCH] improve site generation MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Hervé Boutemy --- pom.xml | 21 +++++++++++++++++++ .../org/cyclonedx/maven/ModelConverter.java | 4 ++-- .../maven/ProjectDependenciesConverter.java | 4 ++-- src/site/site.xml | 1 + .../cyclonedx/maven/BomDependenciesTest.java | 2 +- .../cyclonedx/maven/BundleDependencyTest.java | 2 +- .../org/cyclonedx/maven/CIFriendlyTest.java | 2 +- .../org/cyclonedx/maven/Issue116Test.java | 2 +- .../org/cyclonedx/maven/Issue117Test.java | 2 +- .../org/cyclonedx/maven/Issue284Test.java | 2 +- .../org/cyclonedx/maven/Issue289Test.java | 2 +- .../org/cyclonedx/maven/Issue311Test.java | 2 +- .../java/org/cyclonedx/maven/Issue64Test.java | 2 +- .../java/org/cyclonedx/maven/VerboseTest.java | 2 +- 14 files changed, 36 insertions(+), 14 deletions(-) diff --git a/pom.xml b/pom.xml index eeda46c4..da2f4a7b 100644 --- a/pom.xml +++ b/pom.xml @@ -304,6 +304,23 @@ + + maven-antrun-plugin + 3.1.0 + + + pre-site + + run + + + + + + + + + @@ -445,6 +462,10 @@ maven-plugin-report-plugin ${plugin-tools.version} + + org.apache.maven.plugins + maven-javadoc-plugin + diff --git a/src/main/java/org/cyclonedx/maven/ModelConverter.java b/src/main/java/org/cyclonedx/maven/ModelConverter.java index 32ce8333..a1fd1c2e 100644 --- a/src/main/java/org/cyclonedx/maven/ModelConverter.java +++ b/src/main/java/org/cyclonedx/maven/ModelConverter.java @@ -26,8 +26,8 @@ import org.cyclonedx.model.Metadata; /** - * Model converter from Maven concepts (Artifact + MavenProject) to CycloneDX ones - * (resp. pURL and Component + Metadata). + * Model converter from Maven concepts (dependency Artifact + MavenProject) to CycloneDX ones + * (resp. Component with pURL + Metadata). */ public interface ModelConverter { String generatePackageUrl(Artifact artifact); diff --git a/src/main/java/org/cyclonedx/maven/ProjectDependenciesConverter.java b/src/main/java/org/cyclonedx/maven/ProjectDependenciesConverter.java index 906fb334..92c4bfa6 100644 --- a/src/main/java/org/cyclonedx/maven/ProjectDependenciesConverter.java +++ b/src/main/java/org/cyclonedx/maven/ProjectDependenciesConverter.java @@ -28,8 +28,8 @@ import java.util.Map; /** - * Converts a Maven Project with its Maven dependencies resolution graph transformed into a SBOM dependencies list - * with their dependsOn. + * Converts a Maven Project with its Maven dependencies resolution graph into a SBOM dependencies list + * with their {@code dependsOn}. */ public interface ProjectDependenciesConverter { diff --git a/src/site/site.xml b/src/site/site.xml index d28a9870..484f9cdf 100644 --- a/src/site/site.xml +++ b/src/site/site.xml @@ -40,6 +40,7 @@ + diff --git a/src/test/java/org/cyclonedx/maven/BomDependenciesTest.java b/src/test/java/org/cyclonedx/maven/BomDependenciesTest.java index e6980757..339573d7 100644 --- a/src/test/java/org/cyclonedx/maven/BomDependenciesTest.java +++ b/src/test/java/org/cyclonedx/maven/BomDependenciesTest.java @@ -25,7 +25,7 @@ import io.takari.maven.testing.executor.junit.MavenJUnitTestRunner; /** - * test for https://github.com/CycloneDX/cyclonedx-maven-plugin/issues/256 + * test for issue #256. * */ @RunWith(MavenJUnitTestRunner.class) diff --git a/src/test/java/org/cyclonedx/maven/BundleDependencyTest.java b/src/test/java/org/cyclonedx/maven/BundleDependencyTest.java index 82762dbb..02eed2fc 100644 --- a/src/test/java/org/cyclonedx/maven/BundleDependencyTest.java +++ b/src/test/java/org/cyclonedx/maven/BundleDependencyTest.java @@ -12,7 +12,7 @@ import io.takari.maven.testing.executor.junit.MavenJUnitTestRunner; /** - * test for https://github.com/CycloneDX/cyclonedx-maven-plugin/issues/272 + * test for issue #272: * dependency has a bundle packaging which causes Maven's ProjectBuildingException */ @RunWith(MavenJUnitTestRunner.class) diff --git a/src/test/java/org/cyclonedx/maven/CIFriendlyTest.java b/src/test/java/org/cyclonedx/maven/CIFriendlyTest.java index 5a72cbdb..97969216 100644 --- a/src/test/java/org/cyclonedx/maven/CIFriendlyTest.java +++ b/src/test/java/org/cyclonedx/maven/CIFriendlyTest.java @@ -12,7 +12,7 @@ import io.takari.maven.testing.executor.junit.MavenJUnitTestRunner; /** - * test for https://github.com/CycloneDX/cyclonedx-maven-plugin/issues/263 + * test for issue #263: * when makeAggregateBom using CI-friendly versions, root component does not list modules as dependencies */ @RunWith(MavenJUnitTestRunner.class) diff --git a/src/test/java/org/cyclonedx/maven/Issue116Test.java b/src/test/java/org/cyclonedx/maven/Issue116Test.java index f71cf894..daebeaa0 100644 --- a/src/test/java/org/cyclonedx/maven/Issue116Test.java +++ b/src/test/java/org/cyclonedx/maven/Issue116Test.java @@ -13,7 +13,7 @@ import io.takari.maven.testing.executor.junit.MavenJUnitTestRunner; /** - * test for https://github.com/CycloneDX/cyclonedx-maven-plugin/issues/116 + * test for issue #116: * dependencies in BOM file are missing a reference */ @RunWith(MavenJUnitTestRunner.class) diff --git a/src/test/java/org/cyclonedx/maven/Issue117Test.java b/src/test/java/org/cyclonedx/maven/Issue117Test.java index be389a72..24db132f 100644 --- a/src/test/java/org/cyclonedx/maven/Issue117Test.java +++ b/src/test/java/org/cyclonedx/maven/Issue117Test.java @@ -10,7 +10,7 @@ import io.takari.maven.testing.executor.junit.MavenJUnitTestRunner; /** - * test for https://github.com/CycloneDX/cyclonedx-maven-plugin/issues/117 + * test for issue #117: * issue with pom.xml UTF-8 encoding with Byte Order Mark */ @RunWith(MavenJUnitTestRunner.class) diff --git a/src/test/java/org/cyclonedx/maven/Issue284Test.java b/src/test/java/org/cyclonedx/maven/Issue284Test.java index 41dae0d6..bff78acb 100644 --- a/src/test/java/org/cyclonedx/maven/Issue284Test.java +++ b/src/test/java/org/cyclonedx/maven/Issue284Test.java @@ -24,7 +24,7 @@ import io.takari.maven.testing.executor.junit.MavenJUnitTestRunner; /** - * test for https://github.com/CycloneDX/cyclonedx-maven-plugin/issues/284 + * test for issue #284: * Fix filtering of scopes */ @RunWith(MavenJUnitTestRunner.class) diff --git a/src/test/java/org/cyclonedx/maven/Issue289Test.java b/src/test/java/org/cyclonedx/maven/Issue289Test.java index 802d9810..55426749 100644 --- a/src/test/java/org/cyclonedx/maven/Issue289Test.java +++ b/src/test/java/org/cyclonedx/maven/Issue289Test.java @@ -21,7 +21,7 @@ import io.takari.maven.testing.executor.junit.MavenJUnitTestRunner; /** - * test for https://github.com/CycloneDX/cyclonedx-maven-plugin/issues/289 + * test for issue #289: * NPE when handling relocations */ @RunWith(MavenJUnitTestRunner.class) diff --git a/src/test/java/org/cyclonedx/maven/Issue311Test.java b/src/test/java/org/cyclonedx/maven/Issue311Test.java index 56f78bda..d038bbc4 100644 --- a/src/test/java/org/cyclonedx/maven/Issue311Test.java +++ b/src/test/java/org/cyclonedx/maven/Issue311Test.java @@ -23,7 +23,7 @@ import io.takari.maven.testing.executor.junit.MavenJUnitTestRunner; /** - * test for https://github.com/CycloneDX/cyclonedx-maven-plugin/issues/311 + * test for issue #311. */ @RunWith(MavenJUnitTestRunner.class) @MavenVersions({"3.6.3"}) diff --git a/src/test/java/org/cyclonedx/maven/Issue64Test.java b/src/test/java/org/cyclonedx/maven/Issue64Test.java index a47d3c52..6a763674 100644 --- a/src/test/java/org/cyclonedx/maven/Issue64Test.java +++ b/src/test/java/org/cyclonedx/maven/Issue64Test.java @@ -14,7 +14,7 @@ import io.takari.maven.testing.executor.junit.MavenJUnitTestRunner; /** - * test for https://github.com/CycloneDX/cyclonedx-maven-plugin/issues/64 + * test for issue #64: * include test scoped dependencies */ @RunWith(MavenJUnitTestRunner.class) diff --git a/src/test/java/org/cyclonedx/maven/VerboseTest.java b/src/test/java/org/cyclonedx/maven/VerboseTest.java index 95abd183..2b3355e6 100644 --- a/src/test/java/org/cyclonedx/maven/VerboseTest.java +++ b/src/test/java/org/cyclonedx/maven/VerboseTest.java @@ -10,7 +10,7 @@ import io.takari.maven.testing.executor.junit.MavenJUnitTestRunner; /** - * test for https://github.com/CycloneDX/cyclonedx-maven-plugin/issues/280 + * test for issue #280: * how to switch verbosity off by default, but let the user activate with CLI parameter */ @RunWith(MavenJUnitTestRunner.class)