Add a JSON release artifact for additions and removals
Nobody has claimed this yet.
- Dominant language
- JSON
- Stars
- 5.8k
- Forks
- 2.6k
- Avg merge
- 1d 21h
- Merged PRs (30d)
- 186
Description
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.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Review the BCD release process, its human-readable release notes, and the role of __meta before deciding where a separate artifact belongs. Done means each GitHub release provides a JSON file containing additions and removals, with the handling of explicit renames clarified.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github, json
- Domain
- data, release
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100