[skip ci] docs: intégration template, exécution locale (hooks), CI_SKIP
This commit is contained in:
parent
86b01563fc
commit
ee48b95f54
@ -29,6 +29,13 @@ Ce guide décrit comment utiliser et intégrer les agents de conformité (qualit
|
|||||||
- Exécuter agents: `docker compose -f docker-compose.ci.yml up --abort-on-container-exit`
|
- Exécuter agents: `docker compose -f docker-compose.ci.yml up --abort-on-container-exit`
|
||||||
- Lancer runner: `RUNNER_MODE=runner BASE_URL=... REGISTRATION_TOKEN=... docker compose -f docker-compose.ci.yml up -d`
|
- Lancer runner: `RUNNER_MODE=runner BASE_URL=... REGISTRATION_TOKEN=... docker compose -f docker-compose.ci.yml up -d`
|
||||||
|
|
||||||
|
## 10. Intégration dans un projet existant
|
||||||
|
|
||||||
|
```bash
|
||||||
|
bash scripts/deploy/setup.sh <git_url_du_projet> [--dest DIR] [--force]
|
||||||
|
# Compléter ~/.4nk_template/.env si besoin
|
||||||
|
```
|
||||||
|
|
||||||
## 4. Agents disponibles
|
## 4. Agents disponibles
|
||||||
|
|
||||||
- Documentation (`documentation`): fichiers essentiels et index
|
- Documentation (`documentation`): fichiers essentiels et index
|
||||||
|
@ -44,6 +44,10 @@ Variables utilisées par l’entrypoint `docker/entrypoint.ci.sh`:
|
|||||||
- `RUNNER_MODE` détermine le mode d’exécution
|
- `RUNNER_MODE` détermine le mode d’exécution
|
||||||
- `BASE_URL` et `REGISTRATION_TOKEN` servent à l’enregistrement du runner (act_runner)
|
- `BASE_URL` et `REGISTRATION_TOKEN` servent à l’enregistrement du runner (act_runner)
|
||||||
|
|
||||||
|
## Commit message — désactiver la CI ponctuellement
|
||||||
|
|
||||||
|
- Ajouter `[skip ci]` au message de commit pour ignorer un run côté Gitea Actions
|
||||||
|
|
||||||
## Gestion locale des secrets (~/.4nk_template/.env)
|
## Gestion locale des secrets (~/.4nk_template/.env)
|
||||||
|
|
||||||
- Modèle fourni: `scripts/env/.env.template` (clés sans valeurs)
|
- Modèle fourni: `scripts/env/.env.template` (clés sans valeurs)
|
||||||
|
@ -15,6 +15,14 @@ Ce document explique comment utiliser le template pour initier, documenter, cont
|
|||||||
3) Tenir `docs/INDEX.md` et `CHANGELOG.md` à jour
|
3) Tenir `docs/INDEX.md` et `CHANGELOG.md` à jour
|
||||||
4) Activer les workflows CI et vérifier `release-guard`/`security-audit`
|
4) Activer les workflows CI et vérifier `release-guard`/`security-audit`
|
||||||
|
|
||||||
|
## 2.1 Intégrer 4NK_template dans un projet existant
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Depuis le dépôt 4NK_template
|
||||||
|
bash scripts/deploy/setup.sh <git_url_du_projet> [--dest DIR] [--force]
|
||||||
|
# Compléter ensuite ~/.4nk_template/.env si nécessaire (OPENAI_*, BASE_URL, RELEASE_TOKEN)
|
||||||
|
```
|
||||||
|
|
||||||
## 3. Documentation
|
## 3. Documentation
|
||||||
|
|
||||||
- Utiliser les squelettes de `docs/templates/**` comme base
|
- Utiliser les squelettes de `docs/templates/**` comme base
|
||||||
@ -30,6 +38,50 @@ Ce document explique comment utiliser le template pour initier, documenter, cont
|
|||||||
- Variables utiles: `RUNNER_MODE`, `BASE_URL`, `REGISTRATION_TOKEN`
|
- Variables utiles: `RUNNER_MODE`, `BASE_URL`, `REGISTRATION_TOKEN`
|
||||||
- Script helper: `scripts/dev/run_project_ci.sh`
|
- Script helper: `scripts/dev/run_project_ci.sh`
|
||||||
- Auto‑corrections: `AUTO_FIX=1` pour créer la structure de tests et des squelettes docs
|
- Auto‑corrections: `AUTO_FIX=1` pour créer la structure de tests et des squelettes docs
|
||||||
|
|
||||||
|
## 5. Remplacer la CI par une exécution locale (recommandé)
|
||||||
|
|
||||||
|
- CI neutre par défaut: `CI_SKIP=true` dans le workflow; réactivez en le passant à `false` côté dépôt.
|
||||||
|
- Commits: contrôles rapides avant commit
|
||||||
|
```bash
|
||||||
|
npx -y markdownlint-cli "**/*.md" --ignore "archive/**"
|
||||||
|
AUTO_FIX=1 SCOPE=changed scripts/agents/run.sh
|
||||||
|
# Ajoutez [skip ci] dans le message de commit pour éviter les runs distants
|
||||||
|
```
|
||||||
|
- Push: contrôles complets pré‑push
|
||||||
|
```bash
|
||||||
|
AUTO_FIX=1 SCOPE=all scripts/agents/run.sh
|
||||||
|
bash scripts/security/audit.sh || true
|
||||||
|
# Si outillage présent (exemples): cargo check / go vet / npx eslint / tsc --noEmit / ruff…
|
||||||
|
bash scripts/release/guard.sh || true
|
||||||
|
```
|
||||||
|
- Release locale (puis push tag)
|
||||||
|
```bash
|
||||||
|
echo "vYYYY.MM.P" > TEMPLATE_VERSION
|
||||||
|
git add TEMPLATE_VERSION CHANGELOG.md
|
||||||
|
git commit -m "[skip ci] chore(release): vYYYY.MM.P"
|
||||||
|
git tag -a vYYYY.MM.P -m "release: vYYYY.MM.P (latest)"
|
||||||
|
git push && git push origin vYYYY.MM.P
|
||||||
|
```
|
||||||
|
|
||||||
|
### Hooks conseillés
|
||||||
|
|
||||||
|
`.git/hooks/pre-commit`:
|
||||||
|
```bash
|
||||||
|
#!/usr/bin/env bash
|
||||||
|
set -e
|
||||||
|
npx -y markdownlint-cli "**/*.md" --ignore "archive/**"
|
||||||
|
AUTO_FIX=1 SCOPE=changed scripts/agents/run.sh
|
||||||
|
```
|
||||||
|
|
||||||
|
`.git/hooks/pre-push`:
|
||||||
|
```bash
|
||||||
|
#!/usr/bin/env bash
|
||||||
|
set -e
|
||||||
|
AUTO_FIX=1 SCOPE=all scripts/agents/run.sh
|
||||||
|
bash scripts/security/audit.sh || true
|
||||||
|
bash scripts/release/guard.sh || true
|
||||||
|
```
|
||||||
- Agents utiles en premier passage: `documentation`, `quality-technique`, `open-source`, `securite`, `deploiement`
|
- Agents utiles en premier passage: `documentation`, `quality-technique`, `open-source`, `securite`, `deploiement`
|
||||||
|
|
||||||
## 5. Qualité et CI
|
## 5. Qualité et CI
|
||||||
|
Loading…
x
Reference in New Issue
Block a user