docs(readme): align CI checks description with workflows
Déploiement PROD / check (push) Successful in 3m26s
Déploiement PROD / deploy (push) Successful in 8s

This commit is contained in:
2026-07-26 12:22:31 +04:00
parent 050d583b6b
commit b12d66195d
+14 -10
View File
@@ -198,7 +198,7 @@ Toutes ces sources sont modifiables dans `includes/config.local.php` (voir <<fr-
│ ├── pleroma-adapter.js # Adaptateur Pleroma → API Mastodon │ ├── pleroma-adapter.js # Adaptateur Pleroma → API Mastodon
│ └── pwa-update.js # Enregistrement SW + modal de mise à jour │ └── pwa-update.js # Enregistrement SW + modal de mise à jour
├── scripts/ ├── scripts/
│ └── check.sh # Vérifications du CI en local (avant push) │ └── check.sh # Vérifications qualité en local (avant push)
├── uploads/ # Images d'annonces (non versionné, hors .gitkeep) ├── uploads/ # Images d'annonces (non versionné, hors .gitkeep)
├── index.php # Page d'accueil (agrégateur) ├── index.php # Page d'accueil (agrégateur)
├── video.php # Page de lecture d'une vidéo ├── video.php # Page de lecture d'une vidéo
@@ -917,19 +917,21 @@ NOTE: `asciidoctor-pdf` (utilisé par l'extension AsciiDoc de VSCodium) n'est pa
==== ✅ Vérifications locales et CI/CD ==== ✅ Vérifications locales et CI/CD
Avant de pousser, exécutez les mêmes vérifications que le CI : Avant de pousser, exécutez les vérifications locales complètes :
[source,bash] [source,bash]
---- ----
scripts/check.sh scripts/check.sh
---- ----
Ce script lance : lint PHP (`php -l` sur tous les fichiers, samples inclus), lint JS (`node --check`), rendu AsciiDoc, validation JSON (`site.webmanifest.sample`) et XML (`sitemap.xml.sample`, `browserconfig.xml`), shellcheck. Un outil manquant est signalé et le check correspondant ignoré ; le CI, lui, exécute tout. Ce script lance : lint PHP (`php -l` sur tous les fichiers, samples inclus), lint JS (`node --check`), rendu AsciiDoc, validation JSON (`site.webmanifest.sample`) et XML (`sitemap.xml.sample`, `browserconfig.xml`), shellcheck. Un outil manquant est signalé et le check correspondant ignoré.
Pipelines Gitea Actions (`.gitea/workflows/`) : Pipelines Gitea Actions (`.gitea/workflows/`) :
- *Vérification PR* (`check-pr.yml`) : sur toute pull request vers `main` - *Vérification PR* (`check-pr.yml`) : lint PHP et JS bloquants sur toute pull request vers `main`
- *Déploiement PROD* (`deploy-prod.yml`) : sur push sur `main` — mêmes vérifications, puis déploiement en SSH sur le serveur (`git pull --ff-only` + bump de version du Service Worker, qui déclenche le modal de mise à jour chez les visiteurs) - *Déploiement PROD* (`deploy-prod.yml`) : lint PHP et JS sur push sur `main`, puis déploiement en SSH sur le serveur (`git pull --ff-only` + bump de version du Service Worker, qui déclenche le modal de mise à jour chez les visiteurs)
Les validations AsciiDoc, JSON, XML et shellcheck ne sont plus exécutées dans le CI : elles doivent être passées en local avec `scripts/check.sh`.
La mise en place complète du serveur de production (clone, fichiers d'instance, clés SSH, secrets Gitea) est documentée dans link:DEPLOY.adoc[DEPLOY.adoc]. La mise en place complète du serveur de production (clone, fichiers d'instance, clés SSH, secrets Gitea) est documentée dans link:DEPLOY.adoc[DEPLOY.adoc].
@@ -1134,7 +1136,7 @@ All of these sources can be changed in `includes/config.local.php` (see <<en-con
│ ├── pleroma-adapter.js # Pleroma → Mastodon API adapter │ ├── pleroma-adapter.js # Pleroma → Mastodon API adapter
│ └── pwa-update.js # SW registration + update modal │ └── pwa-update.js # SW registration + update modal
├── scripts/ ├── scripts/
│ └── check.sh # CI checks run locally (before pushing) │ └── check.sh # Local quality checks (before pushing)
├── uploads/ # Announcement images (not versioned, except .gitkeep) ├── uploads/ # Announcement images (not versioned, except .gitkeep)
├── index.php # Homepage (aggregator) ├── index.php # Homepage (aggregator)
├── video.php # Video playback page ├── video.php # Video playback page
@@ -1853,19 +1855,21 @@ NOTE: `asciidoctor-pdf` (used by VSCodium's AsciiDoc extension) cannot be used h
==== ✅ Local checks and CI/CD ==== ✅ Local checks and CI/CD
Before pushing, run the same checks as the CI: Before pushing, run the full local checks:
[source,bash] [source,bash]
---- ----
scripts/check.sh scripts/check.sh
---- ----
This script runs: PHP lint (`php -l` on every file, samples included), JS lint (`node --check`), AsciiDoc rendering, JSON (`site.webmanifest.sample`) and XML (`sitemap.xml.sample`, `browserconfig.xml`) validation, shellcheck. A missing tool is reported and its check skipped; the CI runs everything. This script runs: PHP lint (`php -l` on every file, samples included), JS lint (`node --check`), AsciiDoc rendering, JSON (`site.webmanifest.sample`) and XML (`sitemap.xml.sample`, `browserconfig.xml`) validation, shellcheck. A missing tool is reported and its check skipped.
Gitea Actions pipelines (`.gitea/workflows/`): Gitea Actions pipelines (`.gitea/workflows/`):
- *PR check* (`check-pr.yml`): on every pull request to `main` - *PR check* (`check-pr.yml`): blocking PHP and JS lint on every pull request to `main`
- *PROD deployment* (`deploy-prod.yml`): on push to `main` — same checks, then SSH deployment to the server (`git pull --ff-only` + Service Worker version bump, which triggers the update modal for visitors) - *PROD deployment* (`deploy-prod.yml`): PHP and JS lint on push to `main`, then SSH deployment to the server (`git pull --ff-only` + Service Worker version bump, which triggers the update modal for visitors)
AsciDoc, JSON, XML and shellcheck validation are no longer run in CI: they must be run locally with `scripts/check.sh`.
The full production server setup (clone, instance files, SSH keys, Gitea secrets) is documented in link:DEPLOY.adoc[DEPLOY.adoc]. The full production server setup (clone, instance files, SSH keys, Gitea secrets) is documented in link:DEPLOY.adoc[DEPLOY.adoc].