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

Release web-features as GitHub release with JSON artefact #685

Closed
foolip opened this issue Mar 13, 2024 · 4 comments
Closed

Release web-features as GitHub release with JSON artefact #685

foolip opened this issue Mar 13, 2024 · 4 comments

Comments

@foolip
Copy link
Collaborator

foolip commented Mar 13, 2024

We can probably copy the approach that BCD uses, with an attached data.json.
https://github.com/mdn/browser-compat-data/releases/tag/v5.5.15

Requested by @jcscottiii.

@foolip
Copy link
Collaborator Author

foolip commented Mar 13, 2024

I have manually made a release in the shape I think we should automate:
https://github.com/web-platform-dx/web-features/releases/tag/v0.6.0

@ddbeck
Copy link
Collaborator

ddbeck commented Jun 21, 2024

I think we now need two artifacts.

The first is as described, including data.json without the npm package wrapper on GitHub releases.

The second would be a more comprehensive file containing the single-key status results of getStatus() for each feature. This has come by MDN's request, since they don't want a JS dependency for this data.

For the latter, I think we'll need some extension or variation on the schema for the purposes of this one file. Something like:

status:
  baseline: false
  support:
    chrome: "95"
    edge: "95"
  by_compat_feature:
    api.example.method:
      status:
        baseline: false
        support:
          chrome: "95"
          edge: "95"
    # etc.

@foolip
Copy link
Collaborator Author

foolip commented Jun 24, 2024

That looks good I think, in particular that BCD keys are grouped under features, so that we have the option of having the status of a specific BCD key differ depending on the feature it's part of in the future. This depends on #1173 of course.

@ddbeck
Copy link
Collaborator

ddbeck commented Sep 7, 2024

This is now done automatically as of #1559. I think this is well and truly done now. Closing as complete.

@ddbeck ddbeck closed this as completed Sep 7, 2024
@ddbeck ddbeck removed their assignment Sep 7, 2024
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

No branches or pull requests

2 participants