spec: add compatibility property to Release Document#89
Open
toderash wants to merge 1 commit into
Open
Conversation
Adds an optional `compatibility` map to the Release Document for declaring the tested and verified version range of a release against its platform dependencies. Complements `requires` (hard floor) with a tested ceiling, enabling clients and aggregators to surface informed warnings when the environment exceeds the verified range without blocking installation. Signed-off-by: toderash <brent@toderash.net> Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
compatibilitymap to the Release Documentrequires(hard floor) with a tested range, using the same key format (env:*/ DID) and value syntax (version constraint strings)Motivation
requiresexpresses minimum versions needed for the package to function. It cannot express the tested ceiling — the upper bound of platform versions against which the publisher has verified correct behaviour. Without a structured field for this, clients have no machine-readable way to warn users that their environment is beyond the tested range.The WordPress approach (
Tested up to:in readme.txt) is a single free-form string with no ability to express PHP or other platform ceilings, and is frequently stale. This field uses the same structured format asrequires, making it straightforward for clients and build tools that already handlerequiresto supportcompatibilitywith minimal additional work.Test plan
requiresandsuggestsfor consistency_linksrow alignment in updated property table🤖 Generated with Claude Code