You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
chore: update validation processes in documentation and scripts (#9)
- 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.
Signed-off-by: bthos <el.mogul@outlook.es>
Co-authored-by: bthos <el.mogul@outlook.es>
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+12-7Lines changed: 12 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -150,7 +150,9 @@ Before submitting, validate your entry:
150
150
5.**Verify author is present**: The `author` field is required and cannot be empty
151
151
6.**Verify repository URL**: Ensure the GitHub repository exists and is accessible
152
152
7.**Check for duplicates**: Ensure no other plugin has the same `{author}/{id}` combination
153
-
8.**Build and validate**: Run `npm run build && npm run validate` to ensure everything works
153
+
8.**Validate your plugin**: Run `npm run validate-plugins` to check your plugin.json file
154
+
- CI will automatically build the registry and validate it when you submit a PR
155
+
- You can optionally run `npm run validate-all` for a full local check (includes building registry), but it's not required
154
156
155
157
### Step 5: Install Git Hooks (Optional but Recommended)
156
158
@@ -167,15 +169,18 @@ This will:
167
169
168
170
### Step 6: Submit Pull Request
169
171
170
-
1.**Validate your changes:**
172
+
1.**Validate your plugin:**
171
173
```bash
172
-
npm run validate-all
174
+
npm run validate-plugins
173
175
```
174
176
175
-
This will:
176
-
- Validate individual plugin files
177
+
This checks your plugin.json file. CI will automatically:
178
+
- Validate schema files
179
+
- Validate all plugin files
177
180
- Build the registry from plugins
178
-
- Validate the registry against the schema
181
+
- Validate the built registry against the schema
182
+
183
+
**Optional**: Run `npm run validate-all` for a full local check (builds and validates registry locally), but CI does this automatically.
179
184
180
185
2.**Commit your changes** (with DCO sign-off):
181
186
```bash
@@ -214,7 +219,7 @@ To update your plugin entry:
214
219
1. For **metadata changes** (description, tags, etc.): edit `plugin.json` in the version directory (e.g. `plugins/d/developer-name/example-plugin/1.0.0/plugin.json`).
215
220
2. For a **new version**: create a new version directory (e.g. `plugins/d/developer-name/example-plugin/1.1.0/`) and add a new `plugin.json` there.
216
221
3. Do not change the `author` field or move the plugin to a different author path without coordination.
217
-
4. Run `npm run validate-all`, then commit and submit a pull request. Do **not** commit `registry.json` (CI regenerates it).
222
+
4. Run `npm run validate-plugins` to check your plugin.json, then commit and submit a pull request. Do **not** commit `registry.json` (CI regenerates it automatically).
@@ -193,6 +199,8 @@ The Time Tracker application discovers plugins through:
193
199
194
200
## Local Development
195
201
202
+
**Note**: This section covers commands for repository maintainers. Plugin contributors only need `npm run validate-plugins` to check their plugin.json - CI handles the rest automatically.
203
+
196
204
### Setup
197
205
198
206
```bash
@@ -211,15 +219,21 @@ This will guide you through all required fields and create the correct directory
211
219
212
220
### Building the Registry
213
221
222
+
**Note**: Plugin contributors don't need to build the registry - CI does this automatically. The commands below are for repository maintainers.
223
+
214
224
Build `registry.json` from individual plugin files:
215
225
216
226
```bash
217
227
npm run build
218
228
```
219
229
230
+
**Note**: The `build` script generates/updates `registry.json`. Use `npm run validate` to check an existing `registry.json` without modifying it.
**For plugin contributors**: Run `npm run validate-plugins` to check your plugin.json file. CI will handle building and validating the registry automatically.
235
+
236
+
**For repository maintainers**: Full validation commands:
0 commit comments