-
Notifications
You must be signed in to change notification settings - Fork 74
New issue
Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? # to your account
Reduce dist files to only the additional generated data #1162
Conversation
This comment was marked as outdated.
This comment was marked as outdated.
This is what I thought would happen, but for whatever reason it's not like that. I haven't checked why, it's fine if we still have the Baseline high dates. |
@foolip I pushed a couple of changes to show what it would look like to rename the files so that the dists sort after the YAML files. If/when you rebase, this is the procedure I used to rename the dists: # untrack old dist files without deleting them
$ git rm --cached features/*.dist.yml
# rename dist files (`brew install rename` if you need this or do something clever with your shell of choice)
$ rename --subst .dist.yml .yml.dist features/*.dist.yml
# track dist files
$ git add features/*.yml.dist |
The duplication of data across source and dist means that any changes to the source require regenerating dist. This frequently slows down work as this needs to be done in a checkout. Most commonly, an updated description from a code review suggestion results in failing checks because the dist file is out of sync. The new approach is that a dist file will only contain `compat_features` when they are sourced from BCD, and only contain `status` when it is computed as opposed to manually maintained. A small sacrifice is that Baseline high dates are not checked in, and instead only computed in the build step. The built packages/web-features/index.json is unchanged.
@ddbeck I have rebased now! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm happy with this, provided you fix the prettier error. Feel free to merge immediately (and we can clean up the mess in other PRs). Or we could schedule a time to merge this (on Friday, maybe?) and I can do my best to reduce the number of open PRs between now and then.
This is a very conflict-y PR so I'll get this merged ASAP and just rebase everything else as needed. |
This was accidentally removed in web-platform-dx#1162. It's not clear how the accident happened, but this is the only source *.yml file removed, all other file removals were *.dist.yml, confirmed through `git show --stat c250320 --diff-filter=D`.
The duplication of data across source and dist means that any changes to
the source require regenerating dist. This frequently slows down work as
this needs to be done in a checkout. Most commonly, an updated
description from a code review suggestion results in failing checks
because the dist file is out of sync.
The new approach is that a dist file will only contain
compat_features
when they are sourced from BCD, and only contain
status
when it iscomputed as opposed to manually maintained.
The built packages/web-features/index.json is unchanged.