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

API changes to support SPDX 3.0 #924

Merged
merged 26 commits into from
Feb 27, 2025
Merged

API changes to support SPDX 3.0 #924

merged 26 commits into from
Feb 27, 2025

Conversation

pragnya17
Copy link
Contributor

  1. Update the validation/parsing and generation workflows to reflect the different SPDX 3.0 defined entities.
  2. Add a cmd line parameter for different compliance standards. For example, parse SbomFileExample.txt -complianceStandard NTIA
  3. Make sure there are no duplicate spdx elements
  4. Unit testing command line API changes, workflows, utility methods

@pragnya17 pragnya17 requested a review from a team as a code owner February 7, 2025 18:54
@microsoft microsoft deleted a comment from github-actions bot Feb 26, 2025
@pragnya17
Copy link
Contributor Author

/azp run

@pragnya17
Copy link
Contributor Author

/azp run

@pragnya17
Copy link
Contributor Author

/azp run

@microsoft microsoft deleted a comment from github-actions bot Feb 26, 2025
@microsoft microsoft deleted a comment from github-actions bot Feb 26, 2025
@microsoft microsoft deleted a comment from github-actions bot Feb 26, 2025
@pragnya17
Copy link
Contributor Author

/azp run

Copy link
Contributor

@DaveTryon DaveTryon left a comment

Choose a reason for hiding this comment

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

I flagged some issues that we'll want to address, but they can be in a separate PR and don't need to block this one

Copy link

This PR changes files in the API project. Does it change any of the API interfaces in any way? Please note that this includes the following types of changes:

  • Changing the signature of an existing interface method
  • Adding a new method to an existing interface
  • Adding a required data member to a class that an existing interface method consumes

Because any of these changes can potentially break a downstream consumer with customized interface implementations, these changes need to be treated as breaking changes. Please do one of the following:

Option 1 - Publish this as a breaking change

  1. Update the documentation to show the new functionality
  2. Bump the major version in the next release
  3. Be sure to highlight the breaking changes in the release notes

Option 2 - Refactor the changes to be non-breaking

  1. Review this commit, which adds a new interface in a backward-compatible way
  2. Refactor the change to follow this pattern so that existing interfaces are left completely intact
  3. Bump the minor version in the next release

@pragnya17
Copy link
Contributor Author

/azp run

@microsoft microsoft deleted a comment from github-actions bot Feb 27, 2025
Copy link

This PR changes files in the API project. Does it change any of the API interfaces in any way? Please note that this includes the following types of changes:

  • Changing the signature of an existing interface method
  • Adding a new method to an existing interface
  • Adding a required data member to a class that an existing interface method consumes

Because any of these changes can potentially break a downstream consumer with customized interface implementations, these changes need to be treated as breaking changes. Please do one of the following:

Option 1 - Publish this as a breaking change

  1. Update the documentation to show the new functionality
  2. Bump the major version in the next release
  3. Be sure to highlight the breaking changes in the release notes

Option 2 - Refactor the changes to be non-breaking

  1. Review this commit, which adds a new interface in a backward-compatible way
  2. Refactor the change to follow this pattern so that existing interfaces are left completely intact
  3. Bump the minor version in the next release

@pragnya17
Copy link
Contributor Author

/azp run

@pragnya17 pragnya17 merged commit 8c746d2 into main Feb 27, 2025
5 checks passed
@pragnya17 pragnya17 deleted the ppandrate_Spdx30ApiChanges branch February 27, 2025 01:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants