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.

Sign up for GitHub

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

Jump to bottom

Add meta:enum descriptions for task types #377

Merged
merged 5 commits into from
Feb 10, 2024
Merged

Add meta:enum descriptions for task types #377

merged 5 commits into from
Feb 10, 2024

Conversation

mrutkows
Copy link
Contributor

@mrutkows mrutkows commented Feb 9, 2024 •
edited by jkowalleck
Loading

Fixes #245

  • update JSON docs
  • update XML docs
  • update ProtoBuff docs

@mrutkows
Add descriptions for task types
e0dc610 
Signed-off-by: Matt Rutkowski <mrutkows@us.ibm.com>
@mrutkows mrutkows requested a review from a team as a code owner February 9, 2024 16:31
@mrutkows
Copy link
Contributor Author

mrutkows commented Feb 9, 2024

@jkowalleck Please verify I did this correctly and to your satisfaction. Thanks!

@jkowalleck jkowalleck marked this pull request as draft February 9, 2024 16:33
@jkowalleck jkowalleck linked an issue Feb 9, 2024 that may be closed by this pull request
document and revisit taskType #245
Closed
@jkowalleck jkowalleck added this to the 1.6 milestone Feb 9, 2024
@jkowalleck
Copy link
Member

@mrutkows looks promissing.

I've already marked this PR for milestone 1.6 and linked the related issue.
Please add the "documentation" label to the PR, so reviewers can spot it easily.
You will find this in GitHub's right panel.

I marked is as "draft", since I found some tasks missing.
Please add/check also the XML docs and ProtoBuff docs. if all is done, check the boxed and tasks I've just added to the PR description. If all is done, click the "ready for review" button, so the "draft" mark gets removed, and everybody is aware that this is ready for review.

@mrutkows
Copy link
Contributor Author

mrutkows commented Feb 9, 2024 •
edited
Loading

@jkowalleck Thanks Jan, was not aware that I needed to change XSD and Protobuf as well; will work on now.

However on the other comment (and AFAIK) I do have descriptions for all task types in the current enum. (just double checked). Which one(s) are missing from the JSON schema committed?

@mrutkows
Add descriptions for task types as comments in protobuf schema
07cd714 
Signed-off-by: Matt Rutkowski <mrutkows@us.ibm.com>
@mrutkows mrutkows added the CDX 1.6 related to release v1.6 label Feb 9, 2024
@mrutkows
Add descriptions for task types as comments in v1.6 XSD schema
1c293d8 
Signed-off-by: Matt Rutkowski <mrutkows@us.ibm.com>
@mrutkows mrutkows marked this pull request as ready for review February 9, 2024 18:33
jkowalleck
jkowalleck requested changes Feb 9, 2024
View reviewed changes
schema/bom-1.6.proto Show resolved Hide resolved
@jkowalleck jkowalleck removed CDX 1.6 related to release v1.6 ready for review labels Feb 9, 2024
@mrutkows
Add descriptions for task types as comments in protobuf schema
233bcc5 
Signed-off-by: Matt Rutkowski <mrutkows@us.ibm.com>
@mrutkows
Add descriptions for task types as comments in protobuf schema
7224f3e 
Signed-off-by: Matt Rutkowski <mrutkows@us.ibm.com>
stevespringett
stevespringett approved these changes Feb 9, 2024
View reviewed changes
Copy link
Member

@stevespringett stevespringett left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Thanks @mrutkows. @jkowalleck, your thought?

@jkowalleck
Copy link
Member

LGTM. Thanks @mrutkows. @jkowalleck, your thought?

all fine now. I will merge it, then.

@jkowalleck jkowalleck merged commit b9cf0d4 into CycloneDX:1.6-dev Feb 10, 2024
7 checks passed
This was referenced Feb 10, 2024
Closed
Merged
@mrutkows mrutkows deleted the tasktypes-1.6-dev branch February 11, 2024 18:29
stevespringett added a commit that referenced this pull request Apr 9, 2024
@stevespringett
[WIP] v1.6 (#323)
c5032b8 
## Added

* Core enhancement: Attestation
([#192](#192) via
[#348](#348))
* Core enhancement: Cryptography Bill of Materials — CBOM
([#171](#171),
[#291](#291) via
[#347](#347))
* Feature to express the URL to source distribution
([#98](#98) via
[#269](#269))
* Feature to express the URL to RFC 9116 compliant documents
([#380](#380) via
[#381](#381))
* Feature to express tags/keywords for services and components (via
[#383](#383))
* Feature to express details for component authors
([#335](#335) via
[#379](#379))
* Feature to express details for component and BOM manufacturer
([#346](#346) via
[#379](#379))
* Feature to express communicate concluded values from observed
evidences ([#411](#411)
via [#412](#412))
* Features to express license acknowledgement
([#407](#407) via
[#408](#408))
* Feature to express environmental consideration information for model
cards ([#396](#396) via
[#395](#395))
* Feature to express the address of organizational entities (via
[#395](#395))
* Feature to express additional component identifiers: Universal Bill Of
Receipts Identifier and Software Heritage persistent IDs
([#413](#413) via
[#414](#414))

## Fixed

* Allow multiple evidence identities by XML/JSON schema
([#272](#272) via
[#359](#359))
  This was already correct via ProtoBuff schema.
* Prevent empty `license` entities by XML schema
([#288](#288) via
[#292](#292))
  This was already correct in JSON/ProtoBuff schema.
* Prevent empty or malformed `property` entities by JSON schema
([#371](#371) via
[#375](#375))
  This was already correct in XML/ProtoBuff schema.
* Allow multiple `licenses` in `Metadata` by ProtoBuff schema
([#264](#264) via
[#401](#401))
  This was already correct in XML/JSON schema.

## Changed

* Allow arbitrary `$schema` values by JSON schema
([#402](#402) via
[#403](#403))
* Increased max length of `versionRange` (via
[`3e01ce6`](3e01ce6))
* Harmonized length of `version` (via
[#417](#417))

## Deprecated

* Data model "Component"'s field `author` was deprecated. (via
[#379](#379))
  Use field `authors` or field `manufacturer` instead.
* Data model "Metadata"'s field `manufacture` was deprecated.
([#346](#346) via
[#379](#379))
  Use "Metadata"'s field `component`'s field `manufacturer` instead. 
  - for XML: `/bom/metadata/component/manufacturer`
  - for JSON: `$.metadata.component.manufacturer`
  - for ProtoBuf: `Bom:metadata.component.manufacturer`

## Documentation

* Centralize version and version-range (via
[#322](#322))
* Streamlined SPDX expression related descriptions (via
[#327](#327))
* Enhanced descriptions of `bom-ref`/`refType`
([#336](#336) via
[#344](#344))
* Enhanced readability of enum documentation in JSON schema
([#361](#361) via
[#362](#362))
* Fixed typo "compliment" -> "complement" (via
[#369](#369))
* Added documentation for enum "ComponentScope"'s values in JSON schema
([#293](#293) via
[`d92e58e`](d92e58e))
  Texts were a taken from the existing ones in XML/ProtoBuff schema.
* Added documentation for enum "TaskType"'s values
([#245](#245) via
[#377](#377))
* Improve documentation for data model "Metadata"'s field `licenses`
([#273](#273) via
[#378](#378))
* Added documentation for enum "MachineLearningApproachType"'s values
([#351](#351) via
[#416](#416))
* Rephrased some texts here and there.

## Test data

* Added test data for newly added use cases
* Added quality assurance for our ProtoBuf schemas
([#384](#384) via
[#385](#385))
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@stevespringett stevespringett stevespringett approved these changes

@jkowalleck jkowalleck jkowalleck approved these changes

Assignees
No one assigned
Labels
documentation ready for review
Projects
None yet
Milestone
1.6
Development

Successfully merging this pull request may close these issues.

document and revisit taskType
3 participants
@mrutkows @jkowalleck @stevespringett