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

Add a JSON release artifact for additions and removals #24234

Open
ddbeck opened this issue Aug 27, 2024 · 1 comment
Open

Add a JSON release artifact for additions and removals #24234

ddbeck opened this issue Aug 27, 2024 · 1 comment
Labels
enhancement Nice to have features.

Comments

@ddbeck
Copy link
Collaborator

ddbeck commented Aug 27, 2024

What would you like to see added to BCD?

For each release, I'd like a JSON artifact that contains the release notes' additions and removals. It'd be a structured version of the human-readable release notes.

It's probably too much to ask, but it'd be really helpful to have explicit renames (e.g., key X became key Y) as well.

How impactful do you think this enhancement will be?

This would help me do some work automating the task of assigning work in web-features (triggered by BCD upgrades), to cover new features in web-feature as they're added to the web platform. I'd have an immediate application for this.

Do you have anything more you want to share?

I don't need this to be part of the BCD releases themselves (e.g., I'm not expecting something added to __meta). Rather, I'd like to be able to get a separate JSON file from each BCD release on GitHub.

@ddbeck ddbeck added the enhancement Nice to have features. label Aug 27, 2024
@ddbeck ddbeck changed the title JSON Add a JSON release artifact for additions and removals Aug 27, 2024
@caugner
Copy link
Contributor

caugner commented Oct 23, 2024

For each release, I'd like a JSON artifact that contains the release notes' additions and removals. It'd be a structured version of the human-readable release notes.

The right place to upload this artifact would be here. We may be able to generate it at the same time as the human-readable release notes, and store the artifact for retrieval during the release workflow. 🤔

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Nice to have features.
Projects
None yet
Development

No branches or pull requests

4 participants
@ddbeck @caugner and others