chore: implement repo improvements plan (npm scripts, docs, catalog CI, i18n, validator)
- Add npm scripts: validate, validate:strict, index, readme, chain, catalog, build - Align docs to V4 and 560 skills (GETTING_STARTED, FAQ, BUNDLES, MAINTENANCE, vietnamese) - build-catalog: output to data/ for catalog, bundles, aliases; add to CI and drift check - Add yaml dep, Node setup and catalog step in CI; extend auto-commit and drift msg - Translate CI and MAINTENANCE to English; update CI_DRIFT_FIX and maintenance routine - QUALITY_BAR/CONTRIBUTING: canonical validator npm run validate; legacy note in validate-skills.js
This commit is contained in:
@@ -1,24 +1,23 @@
|
||||
# CI Drift Fix Guide
|
||||
|
||||
**Problem**: The failing job is caused by uncommitted changes detected in `README.md` or `skills_index.json` after the update scripts run.
|
||||
**Problem**: The failing job is caused by uncommitted changes detected in `README.md`, `skills_index.json`, or catalog files after the update scripts run.
|
||||
|
||||
**Error**:
|
||||
|
||||
```
|
||||
❌ Detected uncommitted changes in README.md or skills_index.json. Please run scripts locally and commit.
|
||||
❌ Detected uncommitted changes produced by registry/readme/catalog scripts.
|
||||
```
|
||||
|
||||
**Cause**:
|
||||
Scripts like `scripts/generate_index.py` and `scripts/update_readme.py` modify `README.md` and `skills_index.json`, but the workflow expects these files to have no changes after the scripts are run. Any differences mean the committed repo is out-of-sync with what the generation scripts produce.
|
||||
Scripts like `scripts/generate_index.py`, `scripts/update_readme.py`, and `scripts/build-catalog.js` modify `README.md`, `skills_index.json`, `data/catalog.json`, `data/bundles.json`, `data/aliases.json`, and `CATALOG.md`. The workflow expects these files to have no changes after the scripts run. Any differences mean the committed repo is out-of-sync with what the generation scripts produce.
|
||||
|
||||
**How to Fix (DO THIS EVERY TIME):**
|
||||
|
||||
1. Run the **FULL Validation Chain** locally to regenerate `README.md` e `skills_index.json`:
|
||||
1. Run the **FULL Validation Chain** locally:
|
||||
|
||||
```bash
|
||||
python3 scripts/validate_skills.py
|
||||
python3 scripts/generate_index.py
|
||||
python3 scripts/update_readme.py
|
||||
npm run chain
|
||||
npm run catalog
|
||||
```
|
||||
|
||||
2. Check for changes:
|
||||
@@ -30,10 +29,10 @@ Scripts like `scripts/generate_index.py` and `scripts/update_readme.py` modify `
|
||||
|
||||
3. Commit and push any updates:
|
||||
```bash
|
||||
git add README.md skills_index.json
|
||||
git add README.md skills_index.json data/catalog.json data/bundles.json data/aliases.json CATALOG.md
|
||||
git commit -m "chore: sync generated registry files"
|
||||
git push
|
||||
```
|
||||
|
||||
**Summary**:
|
||||
Always commit and push all changes produced by the registry or readme update scripts. This keeps the CI workflow passing by ensuring the repository and generated files are synced.
|
||||
Always commit and push all changes produced by the registry, readme, and catalog scripts. This keeps the CI workflow passing by ensuring the repository and generated files are synced.
|
||||
|
||||
Reference in New Issue
Block a user