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 BREAKING CHANGE: Remove back-compat interface shims #952

Merged
merged 4 commits into from
Mar 3, 2025

Conversation

DaveTryon
Copy link
Contributor

We added the IConfiguration2 and ILicenseInformationFetcher2 interfaces to maintain backward compatibility with the 3.0 API interface. Since the 4.0 API interface is a breaking change, we can remove the 2 shim interfaces for simplicity.

Note that the concretion classes will end up in a different folder after the SPDX 3.0 changes land
@DaveTryon DaveTryon requested a review from a team as a code owner February 27, 2025 21:34
@DaveTryon
Copy link
Contributor Author

/azp run

Copy link

github-actions bot commented Mar 3, 2025

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

@microsoft microsoft deleted a comment from github-actions bot Mar 3, 2025
@microsoft microsoft deleted a comment from github-actions bot Mar 3, 2025
@DaveTryon
Copy link
Contributor Author

/azp run

Copy link
Member

@sfoslund sfoslund left a comment

Choose a reason for hiding this comment

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

Love being able to delete all this code!

@DaveTryon DaveTryon merged commit 1dce65e into main Mar 3, 2025
5 checks passed
@DaveTryon DaveTryon deleted the DaveTryon/remove-interface-shims branch March 3, 2025 19:14
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