Skip to content

Enhance documentation and CI workflows for plugin validation#14

Merged
bthos merged 7 commits intomainfrom
Update-contribution-guides
Feb 13, 2026
Merged

Enhance documentation and CI workflows for plugin validation#14
bthos merged 7 commits intomainfrom
Update-contribution-guides

Conversation

@bthos
Copy link
Copy Markdown
Collaborator

@bthos bthos commented Feb 13, 2026

  • Update CONTRIBUTING.md and README.md to clarify plugin submission steps and emphasize CI's role in validation and registry building.
  • Introduce new plugins: Billing, Goals, Pomodoro Timer, and Projects & Tasks, each with metadata and versioning.
  • Implement GitHub Actions workflows for automatic validation and registry updates upon PR merges.
  • Adjust validation scripts to improve error handling and streamline the validation process.

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.

- Update CONTRIBUTING.md and README.md to clarify plugin submission steps and emphasize CI's role in validation and registry building.
- Introduce new plugins: Billing, Goals, Pomodoro Timer, and Projects & Tasks, each with metadata and versioning.
- Implement GitHub Actions workflows for automatic validation and registry updates upon PR merges.
- Adjust validation scripts to improve error handling and streamline the validation process.

Signed-off-by: bthos <bthos@example.com>
Signed-off-by: bthos <el.mogul@outlook.es>
Copilot AI review requested due to automatic review settings February 13, 2026 20:38
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 enhances the plugin registry by establishing an automated CI-driven workflow for plugin validation and registry building. It introduces a new GitHub Actions workflow that automatically builds and commits registry.json after PRs are merged to main, eliminating the need for contributors to build the registry locally. The documentation has been significantly expanded and reorganized to emphasize this CI-first approach, with clearer instructions for plugin submission, comprehensive FAQs, and visual examples.

Changes:

  • Added a new build-registry.yml workflow that automatically builds and commits registry.json on push to main
  • Modified validation workflows to gracefully skip registry validation when registry.json doesn't exist during PR checks
  • Updated validation script to exit successfully when registry.json is missing, enabling PR validation without requiring the registry
  • Introduced four new TimeTracker plugins: Billing, Goals, Pomodoro Timer, and Projects & Tasks
  • Extensively revised documentation (README.md, CONTRIBUTING.md, plugins/README.md) to clarify the CI-driven workflow and simplify contribution steps

Reviewed changes

Copilot reviewed 10 out of 10 changed files in this pull request and generated 7 comments.

Show a summary per file
File Description
.github/workflows/build-registry.yml New workflow that builds and commits registry.json after merges to main
.github/workflows/validate-registry.yml Removed push trigger and registry building, now only validates on PRs
.github/workflows/validate-manifest.yml Removed registry building steps, simplified to validate only existing files
scripts/validate.js Added check to gracefully skip validation if registry.json doesn't exist
package.json Removed npm run build from validate-all command chain
registry.json Added four new plugins and updated statistics (may be bootstrap commit)
README.md Major documentation overhaul with clearer examples and CI-focused workflow
CONTRIBUTING.md Reorganized with quick summary, FAQs, and emphasis on CI automation
plugins/README.md Simplified with clearer examples and reference to detailed docs
.github/PULL_REQUEST_TEMPLATE.md Updated checklist to reflect CI-automated validation

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Copy link
Copy Markdown
Contributor

Copilot AI commented Feb 13, 2026

@bthos I've opened a new pull request, #15, to work on those changes. Once the pull request is ready, I'll request review from you.

bthos and others added 5 commits February 13, 2026 21:47
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
- Clarify DCO sign-off requirements in CONTRIBUTING.md, emphasizing the need for a valid email address.
- Rename validation command in package.json from `validate-all` to `validate-files` for better clarity.
- Update README.md to reflect the new validation command and provide additional context on the validation process.
- Modify the create plugin script output message to align with the updated validation command.

Signed-off-by: bthos <el.mogul@outlook.com>
Signed-off-by: bthos <el.mogul@outlook.es>
…tegory for the billing plugin, and remove associated tags.

Signed-off-by: bthos <el.mogul@outlook.es>
@bthos bthos merged commit d102ba9 into main Feb 13, 2026
4 of 5 checks passed
@bthos bthos deleted the Update-contribution-guides branch February 13, 2026 20:57
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.

3 participants