Improve validation and automation for chain JSON files #6394
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
Add validation checks and update workflows for chain JSON files. * **tools/schemaCheck.js**: - Add checks to ensure `shortName` and `name` fields are unique across all chain JSON files. - Add checks to ensure icons referenced in chain JSON files exist in the `_data/icons` directory and follow the correct format. * **.github/workflows/validate_json.yml**: - Add a step to run the `tools/schemaCheck.js` script to validate the JSON schema of the chain files. * **.github/workflows/stale.yml**: - Configure the workflow to manage stale issues and PRs, ensuring unresolved issues are closed after a certain period of inactivity. * **README.md**: - Add a section to explain the automated validation process using GitHub Actions workflows. --- For more details, open the [Copilot Workspace session](https://copilot-workspace.githubnext.com/ethereum-lists/chains?shareId=XXXX-XXXX-XXXX-XXXX).
|
You successfully submitted a PR! Due to the amount of PRs coming in: we will only look at PRs that the CI is happy with. We can also not hold your hand getting the CI green - just look how others that where merged did it and RTFM. So as long as there is any CI check that reports an error - no human will look at this. You might be able to ask for some support after supporting the project - e.g. by sending funds to lists.eth. When you fixed things after a requested change - then you also need to (re-)request a review. |
ligi
requested changes
Dec 12, 2024
Comment on lines
+128
to
+132
| To format the JSON files according to the style defined in `.prettierrc.json`, use the `prettier` tool. Run the following command to format all existing JSON files: | ||
|
|
||
| ``` | ||
| npx prettier --write _data/*/*.json | ||
| ``` |
There was a problem hiding this comment.
this is already stated in another part of the README - do not think it should be repeated. Let's keep things DRY
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.
Add validation checks and update workflows for chain JSON files.
tools/schemaCheck.js:
shortNameandnamefields are unique across all chain JSON files._data/iconsdirectory and follow the correct format..github/workflows/validate_json.yml:
tools/schemaCheck.jsscript to validate the JSON schema of the chain files..github/workflows/stale.yml:
README.md:
For more details, open the Copilot Workspace session.