Skip to content

chore: update validation processes in documentation and scripts#9

Merged
bthos merged 1 commit intomainfrom
chor/improve-contribution-process
Feb 13, 2026
Merged

chore: update validation processes in documentation and scripts#9
bthos merged 1 commit intomainfrom
chor/improve-contribution-process

Conversation

@bthos
Copy link
Copy Markdown
Collaborator

@bthos bthos commented Feb 13, 2026

  • 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

Plugin Submission Checklist

  • Plugin ID follows format: author.plugin-name or lowercase-with-hyphens
  • Manifest passes npm run validate-plugins (or npm run validate-all)
  • SHA256 checksum verified (if distribution with checksums is used)
  • Plugin tested locally
  • README / docs updated if adding new author or changing structure
  • License is valid and specified
  • No malware or suspicious code

Type of Change

  • New plugin
  • Plugin update
  • Metadata fix
  • Documentation
  • Other (describe below)

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.

- 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>
Copilot AI review requested due to automatic review settings February 13, 2026 20:03
@bthos bthos merged commit c868b39 into main Feb 13, 2026
9 checks passed
@bthos bthos deleted the chor/improve-contribution-process branch February 13, 2026 20:04
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 validate to expect an existing registry.json (no longer builds automatically), and updated npm run validate-all to explicitly include the build step
  • Updated documentation (README.md, CONTRIBUTING.md, plugins/README.md) to guide contributors to use npm run validate-plugins instead of npm run validate-all or 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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants