chore: update validation processes in documentation and scripts#9
Merged
Conversation
- Replace `npm run build` with `npm run validate-plugins` in CONTRIBUTING.md and README.md to streamline plugin validation steps. - Clarify that CI will automatically handle registry building and validation upon PR submission. - Update various scripts and workflows to reflect the new validation commands and improve clarity for contributors. Co-authored-by: bthos <el.mogul@outlook.es> Signed-off-by: bthos <el.mogul@outlook.es>
Contributor
There was a problem hiding this comment.
Pull request overview
This PR streamlines the plugin validation workflow for contributors by clarifying the separation between local plugin validation and registry building. The changes shift responsibility for building and validating the registry to CI, while contributors only need to run npm run validate-plugins to check their plugin.json files locally.
Changes:
- Modified
npm run validateto expect an existing registry.json (no longer builds automatically), and updatednpm run validate-allto explicitly include the build step - Updated documentation (README.md, CONTRIBUTING.md, plugins/README.md) to guide contributors to use
npm run validate-pluginsinstead ofnpm run validate-allor manual build commands - Split GitHub workflow steps to clearly separate registry building from validation for better clarity
Reviewed changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| package.json | Separated validate from build; updated validate-all to include explicit build step |
| README.md | Added notes clarifying that contributors only need validate-plugins; CI handles registry building |
| CONTRIBUTING.md | Updated validation instructions to recommend validate-plugins; clarified CI responsibilities |
| plugins/README.md | Updated quick start validation instructions to use validate-plugins |
| scripts/create-plugin.js | Removed npm run build from next steps; simplified workflow for contributors |
| .github/workflows/validate-registry.yml | Split "Build and validate registry" into separate steps for clarity |
| .github/workflows/validate-manifest.yml | Split "Build and validate registry" into separate steps for clarity |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This file contains hidden or 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
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.
npm run buildwithnpm run validate-pluginsin CONTRIBUTING.md and README.md to streamline plugin validation steps.Co-authored-by: bthos el.mogul@outlook.es
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.