Allow optional implementation_url in support data
#16415
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
This change updates the compat-data schema and docs to allow per-browser optional implementation_url values to be specified in the support data for any browser; detailed description: > An optional changeset URL or commit URL for the change which implemented > the feature in the source code for the associated browser; e.g. a > https://trac.webkit.org/changeset/ URL for a changeset whose subject > line is in the form *"Enable [feature name/description]."* or *"Enable > [feature name/description] by default."*. The presence of an > `implementation_url` value indicates that the associated browser has > spec-conformant support for the feature in its source code. Therefore, > an `implementation_url` value can be added even if the feature hasn't > yet shipped in a stable release, but instead only in a Nightly, Canary, > or Technology Preview release — or even if the feature hasn't yet > shipped in any release at all, but has only landed in the source code > for the associated browser. mdn#6896 (comment) and mdn#6896 (comment) are where the idea for this change arose. In summary, the rationale is to have a record in BCD of what changeset landed support for a feature in a particular browser’s codebase. Among other use cases, we have downstream consumers who care only whether or not there’s an implementation of the feature in a particular browser engine — even if that implementation hasn’t yet actually shipped in a major release.
This change updates the compat-data schema docs to provide guidance that implementation_url values will be https://trac.webkit.org/changeset/, https://hg.mozilla.org/mozilla-central/rev/, or https://crrev.com/ URLs. The change also updates the schema itself to constrain the allowed value to a pattern that matches URLs in one of those forms.
Co-authored-by: Daniel D. Beck <daniel@ddbeck.com>
caugner
approved these changes
May 25, 2022
schemas/compat-data.schema.json
Outdated
| @@ -63,6 +63,24 @@ | |||
| "required": ["type", "name"] | |||
| } | |||
| }, | |||
| "implementation_url": { | |||
There was a problem hiding this comment.
To safe space and to be consistent with spec_url, I would suggest a shorter name like implement_url or impl_url.
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.
This PR supersedes #7396 and fixes #126. This PR updates the schema to allow an
implementation_urlproperty, which contains a link to a commit/changeset or a bug for that browser.