Rename validation command in package.json from validate-all to validate-files for clarity. Update README.md to reflect the new command and provide additional context on the validation process. Modify GitHub Actions workflow to clarify that changes to registry.json won't trigger the build workflow, preventing infinite loops.#16
Rename validation command in package.json from validate-all to validate-files for clarity. Update README.md to reflect the new command and provide additional context on the validation process. Modify GitHub Actions workflow to clarify that changes to registry.json won't trigger the build workflow, preventing infinite loops.#16
validate-all to validate-files for clarity. Update README.md to reflect the new command and provide additional context on the validation process. Modify GitHub Actions workflow to clarify that changes to registry.json won't trigger the build workflow, preventing infinite loops.#16Conversation
…idate-files` for clarity. Update README.md to reflect the new command and provide additional context on the validation process. Modify GitHub Actions workflow to clarify that changes to `registry.json` won't trigger the build workflow, preventing infinite loops. Signed-off-by: bthos <el.mogul@outlook.es>
There was a problem hiding this comment.
Pull request overview
This PR improves clarity in the validation workflow by renaming the validate-all command to validate-files and updating related documentation. It also simplifies the build-registry.yml workflow by removing a post-merge validation check and relying on path filtering to prevent infinite workflow loops.
Changes:
- Renamed npm script from
validate-alltovalidate-filesfor better clarity about what the command does - Updated README.md with more accurate description emphasizing the command validates existing files without building
- Simplified build-registry.yml workflow by removing the registry.json modification check and replacing with a clarifying comment about path filtering
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| package.json | Renames validate-all script to validate-files to better reflect that it validates existing files without building the registry |
| README.md | Updates documentation to clarify that validate-files validates existing files and adds helpful note about building registry first |
| .github/workflows/build-registry.yml | Removes post-merge registry.json modification check and fetch-depth configuration, adds comment explaining path filtering prevents infinite loops |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| # Note: registry.json is in root and doesn't match these patterns, | ||
| # so changes to it won't trigger this workflow (preventing infinite loops) |
There was a problem hiding this comment.
The removed registry.json modification check was the only validation enforcing the documented policy that contributors should NOT commit registry.json in PRs (see CONTRIBUTING.md:165,231). While the build workflow will overwrite any incorrect registry.json after merge, removing this check means policy violations won't be caught or reported.
Consider adding a proper pre-merge check in a PR validation workflow (like validate-manifest.yml) that explicitly fails if registry.json modifications are detected. This would catch violations before merge rather than after, providing better feedback to contributors.
| - name: Checkout repository | ||
| uses: actions/checkout@v4 |
There was a problem hiding this comment.
Removing fetch-depth: 0 changes the checkout behavior from fetching full history to shallow clone (default depth of 1). While this works for the current simplified workflow, it may cause issues if future steps need to access git history for comparisons or validations. Since the workflow no longer needs git history for the removed registry.json check, this change is acceptable but worth noting for future modifications.
Signed-off-by: bthos el.mogul@outlook.es
Plugin Submission Checklist
author.plugin-nameor lowercase-with-hyphensnpm run validate-plugins(ornpm run validate-all)distributionwith checksums is used)Type of Change
Plugin Details (if applicable)
Plugin ID:
Version:
License:
Repository / Download URL:
DCO
By submitting this pull request, I certify that my contributions are made under the terms of the Developer Certificate of Origin. All commits are signed off with
git commit -s.