Skip to content

Commit

Permalink
placate linter
Browse files Browse the repository at this point in the history
Signed-off-by: Stewart X Addison <sxa@redhat.com>
  • Loading branch information
sxa committed Jan 3, 2024
1 parent 9208fd5 commit 5f23635
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions cyclonedx-lib/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand All @@ -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.

0 comments on commit 5f23635

Please sign in to comment.