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

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

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

CycloneDX Gradle 插件是一个开源项目，它用于从 Gradle 项目生成 CycloneDX 软件物料清单（SBOM）。该项目主要使用 Groovy 语言编写。

新手常见问题及解决步骤

问题一：如何添加 CycloneDX Gradle 插件到项目中？

解决步骤：

1. 在项目的 build.gradle 文件中添加以下插件依赖：

   plugins {
       id 'org.cyclonedx.bom' version '1.10.0'
   }
   

2. 确保你的 Gradle 项目已经正确配置。

问题二：生成的 SBOM 文件存放在哪里？

解决步骤：

1. 默认情况下，生成的 SBOM 文件会存放在项目的 /build/reports 目录下。
2. 如果需要更改存放位置，可以在 build.gradle 文件中配置 destination 属性，例如：

   cyclonedxBom {
       destination = file("custom/path")
   }
   

问题三：如何排除特定配置或项目生成 SBOM？

解决步骤：

1. 如果需要排除特定的配置，可以在 build.gradle 文件中设置 includeConfigs 和 skipConfigs 属性。例如，只包括 runtimeClasspath 配置，排除 compileClasspath 和 testCompileClasspath 配置：

   cyclonedxBom {
       includeConfigs = ["runtimeClasspath"]
       skipConfigs = ["compileClasspath", "testCompileClasspath"]
   }
   

2. 如果需要排除特定项目，可以设置 skipProjects 属性。例如，排除名为 yourTestSubProject 的子项目：

   cyclonedxBom {
       skipProjects = ["yourTestSubProject"]
   }
   

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