Skip to content

Commit

Permalink
remove optional key call out
Browse files Browse the repository at this point in the history
Signed-off-by: Forest Eckhardt <feckhardt@pivotal.io>
  • Loading branch information
sophiewigmore authored and ForestEckhardt committed Jul 27, 2021
1 parent 90542a7 commit 7575872
Showing 1 changed file with 10 additions and 17 deletions.
27 changes: 10 additions & 17 deletions text/0028-bill-of-materials.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,29 +60,25 @@ repository](https://github.com/paketo-buildpacks/stacks)) should have BOM
metadata that includes in-depth information on all of the OS level packages
installed as part of the stack.

The minimal set of keys to include in these type of BOM entries are:
The set of keys to include in these type of BOM entries are:
```
[[bom]]
name = "<dependency name>"
[bom.metadata]
version = "<dependency version>"
arch = "<compatible architecture>"
summary = "<package summary>"
[bom.metadata.source]
name = "<dependency source name>"
purl = "<package URL>"
version = "<dependency source version>",
upstream-version = "<dependency source upstream version>"
```
The optional set of keys may include:
```
# Optional parameters
[bom.metadata]
arch = "<compatible architecture>"
summary = "<package summary>"
```
This closely resembles the content of the metadata that is already available on
stacks.
The only required fields are `name` and `version`, the rest are strongly
recommended. This structure closely resembles the content of the metadata that
is already available on stacks.

### Directly Installed Dependencies
Dependencies that directly provide runtimes and/or are tools used for
Expand All @@ -94,7 +90,7 @@ Buildpack](https://github.com/paketo-buildpacks/node-engine). These are the
type dependencies that are usually listed in the
[`buildpack.toml` file](https://github.com/paketo-buildpacks/node-engine/blob/main/buildpack.toml).

The minimal set of keys to include in these type of BOM entries are:
The set of keys to include in these type of BOM entries are:
```
[[bom]]
name = "<dependency name>"
Expand All @@ -103,11 +99,6 @@ name = "<dependency name>"
sha256 = "<hash of dependency artifact from uri>"
uri = "<uri to dependency>"
version = "<dependency version>"
```
The optional set of keys may include:
```
# Optional parameters
[bom.metadata]
cpe = "<version-specific common platfrom enumeration>"
purl = "<package URL>"
licenses = [<licenses that the dependency has>]
Expand All @@ -116,6 +107,8 @@ The optional set of keys may include:
uri = "<uri to the dependency source>"
sha256 = "<hash of the dependency source artifact from source-uri>"
```
The only required fields are `name` and `version`, the rest are strongly
recommended.

### Indirectly Installed Dependencies
The final component that we should aim to publish BOM metadata for is for
Expand All @@ -129,7 +122,7 @@ The BOM entries for this category should also include information about the
modules available in the final image, as well as those used to construct the
image.

The minimal set of keys to include in package module BOM entries are:
The set of keys to include in package module BOM entries are:
```
[[bom]]
name = "<module name>"
Expand Down

0 comments on commit 7575872

Please sign in to comment.