ayrisdev/app-store-optimization
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: add critical CI drift fixation guide and update maintenance routine

Browse Source
This commit is contained in:
sck_0
2026-01-26 08:46:15 +01:00
parent 2001965e52
commit d19edbebfb
2 changed files with 55 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
.github/MAINTENANCE.md vendored
View File

@@ -22,10 +22,26 @@ Before ANY commit that adds/modifies skills, run the chain:
_Must return 0 errors for new skills._ _Must return 0 errors for new skills._
2. **Regenerate Index**: 2. **Regenerate Index**:
```bash
python3 scripts/generate_index.py python3 scripts/generate_index.py
``` ```
```
3. **Update Readme**:
```bash
python3 scripts/update_readme.py
```
4. **COMMIT GENERATED FILES**:
```bash
git add skills_index.json README.md
git commit -m "chore: sync generated files"
```
> 🔴 **CRITICAL**: If you skip this, CI will fail with "Detected uncommitted changes".
> See [docs/CI_DRIFT_FIX.md](../docs/CI_DRIFT_FIX.md) for details.
### B. Post-Merge Routine (Must Do) ### B. Post-Merge Routine (Must Do)
After multiple PR merges or significant changes: After multiple PR merges or significant changes:

38
docs/CI_DRIFT_FIX.md Normal file
View File

@@ -0,0 +1,38 @@
# 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.
**Error**:
```
❌ Detected uncommitted changes in README.md or skills_index.json. Please run scripts locally and commit.
```
**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.
**How to Fix (DO THIS EVERY TIME):**
1. Run the scripts locally to regenerate README.md and skills_index.json:
```bash
python3 scripts/generate_index.py
python3 scripts/update_readme.py
```
2. Check for changes:
```bash
git status
git diff
```
3. Commit and push any updates:
```bash
git add README.md skills_index.json
git commit -m "Update README and skills index to resolve CI drift"
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.