From 5f236356541f281d32711738b634a94d777c546e Mon Sep 17 00:00:00 2001 From: Stewart X Addison Date: Wed, 3 Jan 2024 10:51:30 +0000 Subject: [PATCH] placate linter Signed-off-by: Stewart X Addison --- cyclonedx-lib/README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/cyclonedx-lib/README.md b/cyclonedx-lib/README.md index b530fe23f..5dc5740a2 100644 --- a/cyclonedx-lib/README.md +++ b/cyclonedx-lib/README.md @@ -16,10 +16,10 @@ The reference information for the underlying format is available at https://cycl Assuming `--create-sbom` was added the `BUILD_ARGS`, at the end of each build the build will call `generateSBoM` in -[build.sh](https://github.com/adoptium/temurin-build/blob/master/sbin/build.sh). +[build.sh](https://github.com/adoptium/temurin-build/blob/master/sbin/build.sh). This will locate all of the required information, and add it to the SBoM via helper methods in -[sbom.sh](https://github.com/adoptium/temurin-build/blob/master/sbin/common/sbom.sh). +[sbom.sh](https://github.com/adoptium/temurin-build/blob/master/sbin/common/sbom.sh). These functions invoke our [TemurinGenSBOM](https://github.com/adoptium/temurin-build/blob/master/cyclonedx-lib/src/temurin/sbom/TemurinGenSBOM.java) java code (this directory) which takes the SBOM file as a parameter as well @@ -33,7 +33,7 @@ section, or adding the support for a new section. I'll use the example of a formulation section (mostly because the author of this added such a section recently) -1. Check that the version of CycloneDX you are using supports the +1. Check that the version of CycloneDX you are using supports the functionality you want. If not, it will need to be updated. To do this you need to do three steps [Sample PR](https://github.com/adoptium/temurin-build/pull/3558/files): - Update [getDependencies](https://github.com/adoptium/temurin-build/blob/master/cyclonedx-lib/getDependencies) with the new version and SHA @@ -43,5 +43,5 @@ recently) - Updates to [cyclonedx-lib/TemurinGenSBOM.java])https://github.com/adoptium/temurin-build/blob/master/sbin/common/sbom.sh) to add a new parameter, a new function to implement it, the call to that function from the `switch` functionality in the `main` function - Update [cyclonedx-lib/build.xml](https://github.com/adoptium/temurin-build/blob/master/cyclonedx-lib/build.xml) to add tests for the new functionality - Add a new function to [sbin/common/sbom.sh](https://github.com/adoptium/temurin-build/blob/master/sbin/common/sbom.sh) to add the fields you need - - Updates to [sbin/build.sh](https://github.com/adoptium/temurin-build/blob/master/sbin/build.sh) to invoke the new function(s) in sbom.sh + - Updates to [sbin/build.sh](https://github.com/adoptium/temurin-build/blob/master/sbin/build.sh) to invoke the new function(s) in sbom.sh 3. Run the build with `--create-sbom` in the `BUILD_ARGS` and check that it produces the desired output.