Actualiser README.md

README.md

@@ -1,29 +1,66 @@
-# Les pmo-actions
+# L'action `healthchecks-ping`
 
-Les actions de la *petite maison orange* sont des actions réutilisables dans un environnement Gitea.
+Cette action permet d’envoyer un *ping* vers un serveur [Healthchecks.io](https://healthchecks.io) (ou un serveur compatible).  
-Elles sont avant tout faites pour me faciliter la vie dans la gestion de mon nuage personnel.
+Elle est conçue pour être utilisée dans des workflows Gitea avec des runners auto-hébergés.
 
-Pour les inclures utiliser la syntaxe:
+---
+
+## 🔧 Utilisation
 
 ```yaml
-        uses: https://gargoton.petite-maison-orange.fr/pmo-actions/ACTION@main
+- name: Notify healthchecks
+  uses: https://gargoton.petite-maison-orange.fr/pmo-actions/healthchecks-ping@main
 ```
 
-En remplaçant `ACTION` par l'action désirée.
+---
 
-## L'action `healthchecks-ping`
+## 📥 Paramètres
 
-Elle a pour but d'envoyer un ping sur un serveur [`healthchecks.io`](https://healthchecks.io/). Elles acceptent 
+| Nom             | Obligatoire | Par défaut | Description                                                                 |
-quatre valeurs en entrée, dont deux premières sont obligatoires.
+|------------------|-------------|------------|-----------------------------------------------------------------------------|
+| `check_server`   | ✅           | –          | Adresse du serveur Healthchecks, incluant `https://`.                       |
+| `check_uuid`     | ✅           | –          | Identifiant UUID de la vérification.                                        |
+| `check_command`  | ❌           | `stop`     | Commande : `start`, `log`, `fail`, ou `stop`.                               |
+| `check_message`  | ❌           | `""`       | Message transmis avec le ping (visible dans l’interface Healthchecks).      |
+| `debug`          | ❌           | `false`    | Affiche des messages de debug détaillés si activé.                          |
 
-- `server`: l'adresse du serveur inclue le protocole
+---
-            par exemple: `https://monserveur.mondomaine.io`
-- `uuid`: l'identifiant hexadecimal du service. l'*uuid* sera combiné avec
-          l'adresse du serveur pour construire l'URL à sonner:
-          `$serveur/ping/$uuid`
 
-- `command`: cette valeur peut prendre 4 valeurs : `start`|`log`|`fail`|`stop`.
+## ▶️ Exemple de workflow
 
-- `message`: Le message qui sera logguer lors du ping sur le serveur [`healthchecks.io`](https://healthchecks.io/).
+```yaml
+- name: Notify healthchecks (start)
+  uses: https://gargoton.petite-maison-orange.fr/pmo-actions/healthchecks-ping@main
+  with:
+    check_server: https://hc-ping.com
+    check_uuid: a1b2c3d4-1234-5678-9abc-def123456789
+    check_command: start
 
+- name: Build my project
+  run: make build
 
+- name: Notify healthchecks (stop)
+  uses: https://gargoton.petite-maison-orange.fr/pmo-actions/healthchecks-ping@main
+  with:
+    check_server: https://hc-ping.com
+    check_uuid: a1b2c3d4-1234-5678-9abc-def123456789
+    check_message: "Build terminé avec succès ✅"
+```
+
+---
+
+## ⚙️ Comportement
+
+- Si `check_command: fail` est utilisé, **l’action échoue volontairement** (`exit 1`).
+- Si `curl` échoue, l’action affiche l’erreur et échoue également.
+- L’URL appelée par `curl` dépend de la commande :
+  - `https://<check_server>/ping/<uuid>` *(commande `stop` ou vide)*
+  - `https://<check_server>/ping/<uuid>/<check_command>` *(commande `start`, `log`, `fail`)*
+
+---
+
+## 🧡 À propos
+
+Cette action fait partie des actions de la **Petite Maison Orange**.  
+Toutes les actions sont disponibles ici :  
+👉 [https://gargoton.petite-maison-orange.fr/pmo-actions/](https://gargoton.petite-maison-orange.fr/pmo-actions/)