Update build-diff script to also accept a URL #1264
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This update makes the `src/build-diff.js` script accept the canonical URL of a spec as parameter, and build the updates to `index.json` that this URL would trigger if it were added to `specs.json` (or if it would replace the corresponding entry in `specs.json`). The script still accepts commit references, although the syntax was slightly updated to get back to one parameter and better align with `git diff`, from `node src/build-diff HEAD HEAD~2` to `node src/build-diff HEAD..HEAD~2`. The script is now also available as a module and the exported function also accepts additional spec properties on top of the URL. That is not yet used but will be useful for later. Next step is to create a more proper CLI that makes use of the module, can also run tests on the updates, and propose a human-readable report that could be added to a pull request and/or used as commit message.
dontcallmedom
approved these changes
Mar 19, 2024
Co-authored-by: Dominique Hazael-Massieux <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This update makes the
src/build-diff.jsscript accept the canonical URL of a spec as parameter, and build the updates toindex.jsonthat this URL would trigger if it were added tospecs.json(or if it would replace the corresponding entry inspecs.json).The script still accepts commit references, although the syntax was slightly updated to get back to one parameter and better align with
git diff, fromnode src/build-diff HEAD HEAD~2tonode src/build-diff HEAD..HEAD~2.The script is now also available as a module and the exported function also accepts additional spec properties on top of the URL. That is not yet used but will be useful for later.
Next step is to create a more proper CLI that makes use of the module, can also run tests on the updates, and propose a human-readable report that could be added to a pull request and/or used as commit message.