-
Notifications
You must be signed in to change notification settings - Fork 146
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
Normalize "SBOM" to "Sbom" through most of the code base #950
Conversation
…alDocumentReference_
…nalDocumentReference
…t/sbom-tool into DaveTryon/pascal-casing
This reverts commit b118bd9.
This reverts commit d48fc89.
Just curious, how do you test that these refactors don't cause any regression issues? or more generally, how would we test sbom-tool? thanks! |
Class functionality is pinned by the unit tests. CLI functionality is pinned by the end-to-end tests. The API will break, but we already had to break it to add the SPDX 3.0 support. The new bits will be released with a major version bump. We're taking advantage of that opportunity to normalize the interface casing. We'll write a migration document to help guide API consumers through the changes that they will need to implement when moving to the new version. Our internal repo will also need to be updated when we pick up this version, so we'll have something of a validation for the migration guide (which can be updated as needed, without needing to change the API again) |
/azp run |
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:
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
Option 2 - Refactor the changes to be non-breaking
|
/azp run |
(Note: This replaces #947, which got into a state where the base was missing many of the changes from #924)
As called out in #685, our code is very inconsistent in its usage of "SBOM" and "Sbom". Older files seemed to start with "SBOM", then migrated somewhat toward "Sbom", but we have a bit of a mix. We punted on #685 because of compatibility concerns.
As we've discussed separately, SPDX 3.0 is a breaking change, so we have a window of opportunity to standardize our API. This PR is an attempt to name that happen, following the following rules:
SBOMFoo
toSBOMFoo_
, allowing Visual Studio to update all usagesSBOMFoo_
toSbomFoo
, allowing Visual Studio to update all usagesSBOM\w\w
using regular expressions as a way to find cases that may have been missedThe PR itself is broad (93 files), but most of the review should be trivial.
Places where a case-sensitive grep for
SBOM\w\w
finds hits:SBOMApiExample
- trivial change that won't impact the APIProposed roadmap: