Mark package security-only #41
Merged
Conversation
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
Updates README.md file to indicate this project is security-only. Signed-off-by: Matthew Weier O'Phinney <matthew@weierophinney.net>
Version 2.3 made BC-incompatible changes to the plugin API, and it's next-to-impossible to adapt the plugin to work against each of Composer v1, Composer v2 <2.3.0, and Composer v2 >= 2.3.0. As such, we are now restricting usage of this package to the Composer v2.2 LTS or before. Signed-off-by: Matthew Weier O'Phinney <matthew@weierophinney.net>
Indicates that this version requires Composer 2.2 or prior, and how to install or rollback to that version. Signed-off-by: Matthew Weier O'Phinney <matthew@weierophinney.net>
Necessary so that installation does not fail. Signed-off-by: Matthew Weier O'Phinney <matthew@weierophinney.net>
Trailing whitespace in message to the Russian people. Signed-off-by: Matthew Weier O'Phinney <matthew@weierophinney.net>
Ocramius
approved these changes
Jul 14, 2022
Closed
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Per a decision by the Technical Steering Committee, this patch marks the package "security-only", meaning it will only receive updates to resolve security issues going forward.
To accomplish this, I've made the following changes:
README.mdto indicate it is security-only.composer.jsonto restrict to Composer plugin API versions > 1.1 and < 2.3.README.mdand the documentation indicating that this package only works with Composer versions < 2.3.This is due to the fact that 2.3 introduces BC-breaking changes to the plugin API that we cannot accommodate.
The documentation also details how to install Composer 2.2 and/or rollback to that version when needing to use this package.