CycloneDX Maven 插件常见问题解决方案

CycloneDX Maven 插件常见问题解决方案

cyclonedx-maven-plugin Creates CycloneDX Software Bill of Materials (SBOM) from Maven projects 项目地址: https://gitcode.com/gh_mirrors/cy/cyclonedx-maven-plugin

CycloneDX Maven 插件是一个用于生成软件物料清单（SBOM）的开源项目。它主要使用 Java 编程语言编写，利用 Maven 构建工具为项目生成 CycloneDX SBOM，其中包含了项目的所有直接和传递依赖。

新手在使用这个项目时需要特别注意的3个问题及解决步骤

问题一：如何集成 CycloneDX Maven 插件到项目中？

解决步骤：

1. 在你的 Maven 项目的 pom.xml 文件中，添加以下插件配置：

   <plugins>
       <plugin>
           <groupId>org.cyclonedx</groupId>
           <artifactId>cyclonedx-maven-plugin</artifactId>
           <executions>
               <execution>
                   <phase>package</phase>
                   <goals>
                       <goal>makeAggregateBom</goal>
                   </goals>
               </execution>
           </executions>
       </plugin>
   </plugins>
   

2. 确保 pom.xml 文件中没有配置冲突的插件或设置。

3. 构建项目，执行 mvn package 命令，插件将在打包阶段自动生成 SBOM。

问题二：如何排除特定模块或依赖项？

解决步骤：

1. 若要排除包含 "test" 在 artifactId 中的模块，可以在命令行中添加 -DexcludeTestProject 参数。

   mvn clean install -DexcludeTestProject
   

2. 如果需要排除特定的 artifactId 或 groupId，可以在命令行中使用 -DexcludeArtifactId 或 -DexcludeGroupId 参数，参数值为逗号分隔的 ID 列表。

   mvn clean install -DexcludeArtifactId=myModule1,myModule2 -DexcludeGroupId=myGroup1
   

问题三：如何自定义生成的 SBOM 文件？

解决步骤：

1. 在 pom.xml 文件中，cyclonedx-maven-plugin 的 <configuration> 部分，可以设置各种属性来自定义输出的 SBOM 文件。

   <configuration>
       <outputDirectory>${project.build.directory}</outputDirectory>
       <outputName>bom</outputName>
       <outputFormat>all</outputFormat>
       <includeLicenseText>true</includeLicenseText>
       <!-- 其他需要的配置 -->
   </configuration>
   

2. 你可以设置输出目录、文件名、格式以及其他选项，如是否包含许可证文本等。

3. 重新构建项目以应用新的配置。

cyclonedx-maven-plugin Creates CycloneDX Software Bill of Materials (SBOM) from Maven projects 项目地址: https://gitcode.com/gh_mirrors/cy/cyclonedx-maven-plugin