-
-
Notifications
You must be signed in to change notification settings - Fork 32
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
7 changed files
with
118 additions
and
7 deletions.
There are no files selected for viewing
Validating CODEOWNERS rules …
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
# see https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/about-code-owners | ||
|
||
# see the teams: https://github.com/orgs/CycloneDX/teams | ||
|
||
## default | ||
* @CycloneDX/core-team | ||
|
||
## CDX maintained: dedicated maintainer teams are the subject-matter experts. | ||
## But @core-team is additional owner, as they are the only ones that can trigger a merge. | ||
### Go | ||
/cdx/gomod.md @CycloneDX/go-maintainers @CycloneDX/core-team | ||
### JS & Node | ||
/cdx/npm.md @CycloneDX/javascript-maintainers @CycloneDX/core-team | ||
### PHP | ||
/cdx/composer.md @CycloneDX/php-maintainers @CycloneDX/core-team | ||
### Pythpn | ||
/cdx/pipenv.md @CycloneDX/python-maintainers @CycloneDX/core-team | ||
/cdx/poetry.md @CycloneDX/python-maintainers @CycloneDX/core-team |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
# `cdx:composer` Namespace Taxonomy | ||
|
||
| Namespace | Description | | ||
| --------- | ----------- | | ||
| `cdx:composer:package` | Namespace for package specific properties. | | ||
|
||
_Boolean value_ are `true` or `false`. Case sensitive. | ||
|
||
## `cdx:composer:package` Namespace Taxonomy | ||
|
||
| Property | Description | | ||
| -------- | ----------- | | ||
| `cdx:composer:package:type` | The [package type][composer-schema-packageType] of the component. If the property is missing, then assume the value to be `library`. May appear once. | | ||
| `cdx:composer:package:isDevRequirement` | Whether the package was flagged as "dev requirement". _Boolean value_. If the property is missing, then assume the value to be `false`. May appear once. | | ||
| `cdx:composer:package:sourceReference` | 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:composer:package:distReference` | The reference of the distribution archive of this version, e.g. master, 1.0.0 or a commit hash for git. Values may be applied to [`externalReferences`][CDX-useCases-externalReferences] of type `distribution`. _Non-empty string value_. May appear once. May appear once. | | ||
|
||
[composer-schema-packageType]: https://getcomposer.org/doc/04-schema.md#type | ||
[CDX-useCases-externalReferences]: https://cyclonedx.org/use-cases/#external-references |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
# `cdx:npm` Namespace Taxonomy | ||
|
||
| Namespace | Description | | ||
| --------- | ----------- | | ||
| `cdx:npm:package` | Namespace for package specific properties. | | ||
| `cdx:npm:package:constraint` | Namespace for package constraints. | | ||
|
||
_Boolean value_ are `true` or `false`. Case sensitive. | ||
|
||
## `cdx:npm:package` Namespace Taxonomy | ||
|
||
| Property | Description | | ||
| -------- | ----------- | | ||
| `cdx:npm:package:bundled` | Whether the package was bundled(shipped) with its parent component. _Boolean value_. If the property is missing, then assume the value to be `false`. May appear once. | | ||
| `cdx:npm:package:extraneous` | Whether the package was installed extraneous. _Boolean value_. If the property is missing, then assume the value to be `false`. May appear once. | | ||
| `cdx:npm:package:private` | Whether the package was flagged as "private". _Boolean value_. If the property is missing, then assume the value to be `false`. May appear once. | | ||
| `cdx:npm:package:development` | Whether the package was flagged as "devDependency". _Boolean value_. If the property is missing, then assume the value to be `false`. May appear once. | | ||
| `cdx:npm:package:path` | A path the package is installed to. Posix-like path representation relative to the root directory of the project under analysis. To represent the root dir, an empty string is used. May appear multiple times with different values. Example value: `node_modules/cliui/node_modules/strip-ansi` | | ||
|
||
## `cdx:npm:package:constraint` Namespace Taxonomy | ||
|
||
| Property | Description | | ||
| -------- | ----------- | | ||
| `cdx:npm:package:constraint:engine:<NAME>` | Supported/required [engine marker](https://docs.npmjs.com/cli/v8/configuring-npm/package-json#engines). May appear once. Example: `cdx:npm:package:constraint:engine:node = >=12.2`| | ||
| `cdx:npm:package:constraint:engine-strict` | Whether the engine is a requirement, or an advice. _Boolean value_. If the property is missing, then assume the value to be `false`. May appear once. | | ||
| `cdx:npm:package:constraint:os` | Supported/required [operating system markers](https://docs.npmjs.com/cli/v8/configuring-npm/package-json#os). May appear multiple times with different values. | |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
# `cdx:pipenv` Namespace Taxonomy | ||
|
||
| Namespace | Description | | ||
| --------- | ----------- | | ||
| `cdx:pipenv:package` | Namespace for package specific properties. | | ||
|
||
## `cdx:pipenv:package` Namespace Taxonomy | ||
|
||
| Property | Description | | ||
| -------- | ----------- | | ||
| `cdx:pipenv:package:category` | Name of a [package category](https://pipenv.pypa.io/en/latest/basics/#specifying-package-categories) the component belongs to. Well-known categories are: "default", "develop". May appear multiple times with different values. | |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
# `cdx:poetry` Namespace Taxonomy | ||
|
||
| Namespace | Description | | ||
| --------- | ----------- | | ||
| `cdx:poetry:package` | Namespace for package specific properties. | | ||
|
||
## `cdx:poetry:package` Namespace Taxonomy | ||
|
||
| Property | Description | | ||
| -------- | ----------- | | ||
| `cdx:poetry:package:group` | Name of a [dependency group](https://python-poetry.org/docs/managing-dependencies/#dependency-groups) the component belongs to. Well-known groups are: "main", "dev". May appear multiple times with different values. | |