diff --git a/software/README.md b/software/README.md index baa86f1..817201b 100644 --- a/software/README.md +++ b/software/README.md @@ -10,7 +10,11 @@ Directories of the form `example#` are structured as follows: - `content/src/`: contains the example's source code - `content/build/`: contains the example's built artifacts -- `spdx/`: contains one or more SPDX documents (in tag-value or JSON format) for the sources and the build artifacts +- `spdx2.2/`: contains one or more SPDX 2.2 documents (in tag-value or JSON + format) for the sources and the build artifacts +- `spdx3.0/`: contains one or more SPDX 3.0 documents for the sources and the + build artifacts + - `README.md`: more details about the particular example Each directory contains build metadata which is used to create the build artifacts. It assumes that the necessary tools (make, gcc, etc.) are present on your system, and doesn't do any autoconfiguration or the like. @@ -32,4 +36,3 @@ Each directory contains build metadata which is used to create the build artifac | 11 | 1 Rust file | compiled with Cargo | 1 document | SBOM describing both source and artifact, related with GENERATED_FROM | | 12 | 1 Ruby library | built using `bundle` | 1 document | SBOM describing Ruby library packaged in a gem | | 13 | Bundled app with a package and container | No compiling - hypothetical example | Documents in progress | SBOM describing a hypothetical "Acme Aplication" | - diff --git a/software/example13/README.md b/software/example13/README.md index 26acfa5..6cf5f32 100644 --- a/software/example13/README.md +++ b/software/example13/README.md @@ -4,4 +4,6 @@ This is a hypothetical example of a "simple" piece of software, Acme Application version 1.3. This example shows what an SPDX-3.0 document looks like for said Acme Application. The idea for this example is that other profiles will be able to build on top of this and demonstrate how all the profiles can work in harmony. -In this specific example, Acme Application is a bundled and distributed piece of software. When Acme Application is run, it pulls in the `alpine:latest` container image which runs in parallel to the `npm-elliptic` library that is packaged and distributed within the Acme Application binary. Among others not depicted for the sake of simplicity, `openssl` is a package included in the `alpine:latest` container image. The example-13 SBOM describes the Acme Application top level piece of software. +In this specific example, Acme Application is a bundled and distributed piece of software. When Acme Application is run, it pulls in the `alpine:latest` container image which runs in parallel to the `npm-elliptic` library that is packaged and distributed within the Acme Application binary. Among others not depicted for the sake of simplicity, `openssl` is a package included in the `alpine:latest` container image. The example13 SBOM describes the Acme Application top level piece of software. + +![A diagram of Acme Application](./example13.png "A diagram of Acme Application") diff --git a/software/example13/spdx-3.0/example-13.drawio b/software/example13/example13.drawio similarity index 100% rename from software/example13/spdx-3.0/example-13.drawio rename to software/example13/example13.drawio diff --git a/software/example13/example-13.png b/software/example13/example13.png similarity index 100% rename from software/example13/example-13.png rename to software/example13/example13.png diff --git a/software/example13/spdx-3.0/example-13-spdx-3.json b/software/example13/spdx3.0/example13.spdx3.json similarity index 97% rename from software/example13/spdx-3.0/example-13-spdx-3.json rename to software/example13/spdx3.0/example13.spdx3.json index fe2b391..8a56437 100644 --- a/software/example13/spdx-3.0/example-13-spdx-3.json +++ b/software/example13/spdx3.0/example13.spdx3.json @@ -6,7 +6,7 @@ "spdxId": "urn:jane-doe-1@acme.com-4fe40e24-20e3-11ee-be56-0242ac120002", "creationInfo": "_:creationinfo", "name": "Application Owner Jane Doe", - "externalIdentifiers": [ + "externalIdentifier": [ { "type": "ExternalIdentifier", "externalIdentifierType": "email", @@ -25,7 +25,7 @@ "spdxId": "urn:github.com-indutny-c4fe40e24-20e3-11ee-be56-0242ac120002", "creationInfo": "_:creationinfo", "name": "Fedor Indutny", - "externalIdentifiers": [ + "externalIdentifier": [ { "type": "ExternalIdentifier", "externalIdentifierType": "other", @@ -91,7 +91,7 @@ "software_packageVersion": "6.5.2", "suppliedBy": "urn:github.com-indutny-c4fe40e24-20e3-11ee-be56-0242ac120002", "software_primaryPurpose": "library", - "externalIdentifiers": [ + "externalIdentifier": [ { "type": "ExternalIdentifier", "externalIdentifierType": "other", @@ -139,7 +139,7 @@ "creationInfo": "_:creationinfo", "from": "urn:product-acme-application-1.3-4fe40e24-20e3-11ee-be56-0242ac120002", "to": "urn:container-alpine-latest-sha256:69665d02cb32192e52e07644d76bc6f25abeb5410edc1c7a81a10ba3f0efb90a-4fe40e24-20e3-11ee-be56-0242ac120002", - "relationshipType": "depends_on" + "relationshipType": "dependsOn" }, { "type": "Relationship", diff --git a/software/example13/spdx3.0/example13.spdx3.png b/software/example13/spdx3.0/example13.spdx3.png new file mode 100644 index 0000000..49634be Binary files /dev/null and b/software/example13/spdx3.0/example13.spdx3.png differ