Skip to content

Commit

Permalink
Merge branch 'spdx:main' into add-spec-markdown-docs
Browse files Browse the repository at this point in the history
  • Loading branch information
bact authored Oct 9, 2024
2 parents dd8ac76 + 01b3846 commit 267f7aa
Show file tree
Hide file tree
Showing 18 changed files with 54 additions and 127 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/validate-pr.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ jobs:
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
- uses: actions/checkout@eef61447b9ff4aafe5dcd4e0bbf5d482be7e7871 # v4.2.1
- uses: actions/setup-python@f677139bbe7f9c59b41e40162b753c062f5d49a3 # v5.2.0
with:
python-version: "3.12"
Expand Down
21 changes: 17 additions & 4 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Change Log

## 3.0.1 (under development - last update 2024-08-14)
## 3.0.1 (Unrelease - under development - last update 2024-09-25)

### Changes since 3.0

Expand All @@ -23,11 +23,24 @@
- **Added:** `adler32` entry to `Core/HashAlgorithm` - [#826](https://github.com/spdx/spdx-3-model/pull/826)
- The Adler-32 checksum, previously available in SPDX 2.3, has been
reintroduced.
- **Clarified:** `AI/autonomyType` property - [#741](https://github.com/spdx/spdx-3-model/pull/741)
- **Added:** `Core/SpdxOrganization` - [#880](https://github.com/spdx/spdx-3-model/pull/880)
- An `SpdxOrganization` individual, an Organization representing the SPDX
Project, is added. It is by definition the creator of all Element type individuals
defined by the SPDX Project.
- **Clarified:** `AI/autonomyType` - [#741](https://github.com/spdx/spdx-3-model/pull/741)
- Specified the meaning of `yes`, `no`, and `noAssertion` values in the
`AI/autonomyType` property description.
- **Clarified:** `Build/buildType` - [#875](https://github.com/spdx/spdx-3-model/pull/875)
- Its intent is added: "The buildType is used to interpret the meaning of
other build parameters by defining the "type" of build...".
- **Clarified:** `hasData` entry in `Core/RelationshipType` - [#815](https://github.com/spdx/spdx-3-model/pull/815)
- **Improved:** JSON-LD examples.
- All JSON-LD examples in the "Syntax" section of class descriptions are now
validated.
validated - [#794](https://github.com/spdx/spdx-3-model/pull/794)
- Added JSON-LD examples for `AI/EnergyConsumption` and
`AI/EnergyConsumptionDescription`.
`AI/EnergyConsumptionDescription` - [#780](https://github.com/spdx/spdx-3-model/pull/780)
- **Updated:** Model diagrams.
- Use updated names
- Specify XSD data types
- All named individuals are removed - [#884](https://github.com/spdx/spdx-3-model/pull/884)
- General typos and formatting fixes
Binary file modified images/model-core-software.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion images/model-core-software.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified images/model-core.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion images/model-core.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified images/model-licensing.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion images/model-licensing.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
122 changes: 18 additions & 104 deletions model.drawio

Large diffs are not rendered by default.

5 changes: 2 additions & 3 deletions model/AI/AI.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,7 @@ the following has to hold:

1. for every `/AI/AIPackage` there MUST exist exactly one `/Core/Relationship`
of type `hasConcludedLicense` having that element as its `from` property
and an `/SimpleLicensing/AnyLicenseInfo` as its `to` property.
and a `/SimpleLicensing/AnyLicenseInfo` as its `to` property.
2. for every `/AI/AIPackage` there MUST exist exactly one `/Core/Relationship`
of type `hasDeclaredLicense` having that element as its `from` property
and an `/SimpleLicensing/AnyLicenseInfo` as its `to` property.

and a `/SimpleLicensing/AnyLicenseInfo` as its `to` property.
2 changes: 1 addition & 1 deletion model/Core/Datatypes/MediaType.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ SPDX-License-Identifier: Community-Spec-1.0
## Summary

Standardized way of indicating the type of content of an Element or a Property.
A String constrained to the RFC 2046 specificiation.
A String constrained to the RFC 2046 specification.

## Description

Expand Down
2 changes: 1 addition & 1 deletion model/Core/Individuals/NoAssertionElement.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ For example, a Relationship with
and
`to`=NoAssertionElement
is explicitly expressing that
no assertion is being made about any potential descendents of Element1.
no assertion is being made about any potential descendants of Element1.

## Metadata

Expand Down
2 changes: 1 addition & 1 deletion model/Core/Individuals/NoneElement.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ For example, a Relationship with
`from`=Element1,
and `to`=NoneElement
is explicitly expressing an assertion that
Element1 has no descendents.
Element1 has no descendants.

## Metadata

Expand Down
3 changes: 2 additions & 1 deletion model/Core/Individuals/SpdxOrganization.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,8 @@ An Organization representing the SPDX Project.
## Description

SpdxOrganization is an Organization representing the SPDX Project.
It is by definition the creator of all individuals defined by the SPDX Project.
It is by definition the creator of all Element type individuals defined by
the SPDX Project.
These individuals include licences and exceptions defined in the SPDX License
List, as well as individuals defined in the specification.

Expand Down
4 changes: 2 additions & 2 deletions model/Dataset/Dataset.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,9 @@ the following has to hold:

1. for every `/Dataset/DatasetPackage` there MUST exist exactly one
`/Core/Relationship` of type `hasConcludedLicense` having that element as its
`from` property and an `/SimpleLicensing/AnyLicenseInfo` as its `to`
`from` property and a `/SimpleLicensing/AnyLicenseInfo` as its `to`
property.
2. for every `/Dataset/DatasetPackage` there MUST exist exactly one
`/Core/Relationship` of type `hasDeclaredLicense` having that element as its
`from` property and an `/SimpleLicensing/AnyLicenseInfo` as its `to`
`from` property and a `/SimpleLicensing/AnyLicenseInfo` as its `to`
property.
2 changes: 1 addition & 1 deletion model/Licensing/Licensing.md
Original file line number Diff line number Diff line change
Expand Up @@ -119,5 +119,5 @@ the following has to hold:

1. for every `/Software/SoftwareArtifact` there MUST exist exactly one
`/Core/Relationship` of type `hasConcludedLicense` having that element as
its `from` property and an `/SimpleLicensing/AnyLicenseInfo` as its `to`
its `from` property and a `/SimpleLicensing/AnyLicenseInfo` as its `to`
property.
4 changes: 2 additions & 2 deletions model/Lite/Lite.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,11 +40,11 @@ Additionally:

1. for every `/Software/Package` there MUST exist exactly one
`/Core/Relationship` of type `hasConcludedLicense` having that element as
its `from` property and an `/SimpleLicensing/AnyLicenseInfo` as its `to`
its `from` property and a `/SimpleLicensing/AnyLicenseInfo` as its `to`
property.
2. for every `/Software/Package` there MUST exist exactly one
`/Core/Relationship` of type `hasDeclaredLicense` having that element as its
`from` property and an `/SimpleLicensing/AnyLicenseInfo` as its `to`
`from` property and a `/SimpleLicensing/AnyLicenseInfo` as its `to`
property.

For a `/Core/SpdxDocument` to be conformant with this profile, the following has to hold:
Expand Down
6 changes: 3 additions & 3 deletions model/Security/Classes/VexVulnAssessmentRelationship.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ SPDX-License-Identifier: Community-Spec-1.0

## Summary

Asbtract ancestor class for all VEX relationships
Abstract ancestor class for all VEX relationships

## Description

Expand All @@ -17,10 +17,10 @@ When linking elements using a VexVulnAssessmentRelationship, the following
requirements must be observed:

- The from: end must be a /Security/Vulnerability classed element
- The to: end must point to elements representing the VEX _products_.
- The to: end must point to elements representing the VEX *products*.

To specify a different element where the vulnerability was detected, the VEX
relationship can optionally specify _subcomponents_ using the assessedElement
relationship can optionally specify *subcomponents* using the assessedElement
property.

VEX inherits information from the document level down to its statements. When a
Expand Down

0 comments on commit 267f7aa

Please sign in to comment.