Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

software/example13: Fix property name and value #82

Closed
wants to merge 5 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions software/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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" |

4 changes: 3 additions & 1 deletion software/example13/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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")
File renamed without changes
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
"spdxId": "urn:[email protected]",
"creationInfo": "_:creationinfo",
"name": "Application Owner Jane Doe",
"externalIdentifiers": [
"externalIdentifier": [
{
"type": "ExternalIdentifier",
"externalIdentifierType": "email",
Expand All @@ -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",
Expand Down Expand Up @@ -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",
Expand Down Expand Up @@ -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",
Expand Down
Binary file added software/example13/spdx3.0/example13.spdx3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.