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

fix some cdx:python properties #96

Merged
merged 5 commits into from
Aug 31, 2024
Merged
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
15 changes: 14 additions & 1 deletion cdx/poetry.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,20 @@

| Property | Description |
|----------|-------------|
| `cdx:poetry:package:source:reference` | The repository reference of this package, e.g. master, 1.0.0 or a commit hash for git. Values may be applied to [`externalReferences`][CDX-useCases-externalReferences] of type `vcs`. _Non-empty string value_. May appear once. |
| `cdx:poetry:package:source:reference` | The repository reference of this package, e.g. "master", "1.0.0" or a commit hash for git. Values may be applied to [`externalReferences`][CDX-useCases-externalReferences] of type `vcs`. _Non-empty string value_. May appear once. |
| `cdx:poetry:package:source:resolved_reference` | The resolved repository reference of this package, e.g. a commit hash for git. Values may be applied to [`externalReferences`][CDX-useCases-externalReferences] of type `vcs`. _Non-empty string value_. May appear once. |

| Namespace | Description |
|-----------|-------------|
| `cdx:poetry:package:source:vcs` | **DEPRECATED** namespace for package-source's VCS specific properties. |

## `cdx:poetry:package:source:vcs` Namespace Taxonomy

This namespace is **deprecated** in favor of the more general [`cdx:python:package:source:vcs`](./python.md), or consider the properties mentioned above.

| Property | Description |
|----------|-------------|
| `cdx:poetry:package:source:vcs:requested_revision` | The repository reference of this package, e.g. "master", "1.0.0" or a commit hash for git. Values may be applied to [`externalReferences`][CDX-useCases-externalReferences] of type `vcs`. _Non-empty string value_. May appear once. |
| `cdx:poetry:package:source:vcs:commit_id` | The resolved repository reference of this package, e.g. a commit hash for git. Values may be applied to [`externalReferences`][CDX-useCases-externalReferences] of type `vcs`. _Non-empty string value_. May appear once. |

[CDX-useCases-externalReferences]: https://cyclonedx.org/use-cases/#external-references
5 changes: 3 additions & 2 deletions cdx/python.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ In accordance with [packaging's `direct-url` data structure for Archive](https:/

| Property | Description |
|----------|-------------|
| | |

There are no properties regiestered so far.
The `hashes` of an archive should be added to the [`ExternalReference`][CDX-useCases-externalReferences] that represents the package source.
Expand All @@ -49,8 +50,8 @@ In accordance with [packaging's `direct-url` data structure for VCS](https://pac

| Property | Description |
|----------|-------------|
| `cdx:poetry:package:source:vcs:requested_revision` | The repository reference of this package, e.g. master, 1.0.0 or a commit hash for git. Values may be applied to [`externalReferences`][CDX-useCases-externalReferences] of type `vcs`. _Non-empty string value_. May appear once. |
| `cdx:poetry:package:source:vcs:commit_id` | The resolved repository reference of this package, e.g. a commit hash for git. Values may be applied to [`externalReferences`][CDX-useCases-externalReferences] of type `vcs`. _Non-empty string value_. May appear once. |
| `cdx:python:package:source:vcs:requested_revision` | The repository reference of this package, e.g. "master", "1.0.0" or a commit hash for git. Values may be applied to [`externalReferences`][CDX-useCases-externalReferences] of type `vcs`. _Non-empty string value_. May appear once. |
| `cdx:python:package:source:vcs:commit_id` | The resolved repository reference of this package, e.g. a commit hash for git. Values may be applied to [`externalReferences`][CDX-useCases-externalReferences] of type `vcs`. _Non-empty string value_. May appear once. |

## `cdx:python:package:source:local` Namespace Taxonomy

Expand Down