Skip to content

Conversation

rviscomi
Copy link
Collaborator

@rviscomi rviscomi commented Sep 11, 2025

Progress on #3060

  • generate by_compat_key data as part of the main index script for data.json
  • continue making data.extended.json available in the GitHub release artifacts for backwards compatibility
  • update docs and workflows

@github-actions github-actions bot added documentation Improvements or additions to documentation tools and infrastructure Project internal tooling, such as linters, GitHub Actions, or repo settings labels Sep 11, 2025
@rviscomi rviscomi requested review from ddbeck and foolip October 3, 2025 14:43
Copy link
Collaborator

@ddbeck ddbeck left a comment

Choose a reason for hiding this comment

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

Overall, I'd very much like to get the extended data into the web-features package and I'm supportive. That said, I've got two main suggestions here (more detail in line comments):

  • I'd prefer to change the way we generate data.json so that it's equivalent to data.extended.json. I think the one and only place we should have a data.extended.json is in the GitHub release artifacts (so that anyone depending on that URL still gets the data, at least until our next breaking release).
  • I'd prefer to introduce utility functions separately. I think there's more discussion to have on that front and I don't want it to block providing the full data set.

@ddbeck
Copy link
Collaborator

ddbeck commented Oct 15, 2025

Oh, one more thing: I pretty sure by_compat_key ought to be a required key in the schema, when we land this.

"by_compat_key": {
"description": "Statuses for each key in the feature's compat_features list, if applicable. Not available to the npm release of web-features.",
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/Status"
}
}
},
"required": ["baseline", "support"],

@rviscomi rviscomi changed the title Add data.extended.json to the web-features package Merge data.extended.json into data.json Oct 16, 2025
@rviscomi
Copy link
Collaborator Author

Oh, one more thing: I pretty sure by_compat_key ought to be a required key in the schema, when we land this.

I tried this, but by_compat_key depends on compat_features, which is optional. If we really want it to be required, should compat_features be required too? We could initialize both to empty objects and arrays respectively, but I'm not sure that adds much value.

@rviscomi rviscomi requested a review from ddbeck October 16, 2025 13:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation tools and infrastructure Project internal tooling, such as linters, GitHub Actions, or repo settings

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants