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.

Sign up for GitHub

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

Jump to bottom

Improve changelog (at least for major bumps) #704

Open
dontcallmedom opened this issue Aug 19, 2022 · 1 comment
Open

Improve changelog (at least for major bumps) #704

dontcallmedom opened this issue Aug 19, 2022 · 1 comment

Comments

@dontcallmedom
Copy link
Member

we had two customers seeking clarity on the major bump of our latest @webref/css, which I take as a signal we should be more explicit about these :)
#688 (comment)
mdn/yari#6913 (comment)
@tidoust
Copy link
Member

tidoust commented Aug 19, 2022

Right, an artefact of our release workflow is that the commit that bumps the version and that highlights the breaking change isn't directly visible when the package gets released.

Now, to improve the changelog, we would need to have a changelog in the first place ;)

tidoust added a commit that referenced this issue Sep 14, 2022
@tidoust
Add schemas for all JSON extracts
cd42d20 
This provides a first level of schema validation for curated data extracts,
see #657 for context.

Goal is to make it easier to detect and document (through a changelog, so also
useful for #704) situations where we change the structure of data extracts.

Schemas, notably those that deal with parsed IDL structures, could go deeper
into details.

Tests are run against the curated version of data. That is not necessary for
extracts that aren't actually curated (dfns, headings, ids, links, refs), just
more convenient not to have branching logic in the test code.
@tidoust tidoust mentioned this issue Sep 14, 2022
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@dontcallmedom @tidoust