Enhance documentation and CI workflows for plugin validation#14
Merged
Conversation
- 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>
Contributor
There was a problem hiding this comment.
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.ymlworkflow 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>
Contributor
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>
…kr/plugins-registry into Update-contribution-guides
…tegory for the billing plugin, and remove associated tags. Signed-off-by: bthos <el.mogul@outlook.es>
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.
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.