From 884edebd141d949e1098b62259dfea13fee5b89c Mon Sep 17 00:00:00 2001 From: Eric Coissac Date: Mon, 14 Apr 2025 14:28:05 +0200 Subject: [PATCH] Actualiser README.md --- README.md | 55 +++++++++++++++++++++++-------------------------------- 1 file changed, 23 insertions(+), 32 deletions(-) diff --git a/README.md b/README.md index cf4e541..e1425f5 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ -# L'action `healthchecks-ping` +# L'action `software-version` -Cette action permet d’envoyer un *ping* vers un serveur [Healthchecks.io](https://healthchecks.io) (ou un serveur compatible). +Cette action extrait le numéro de version d’un logiciel à partir d’un fichier, généralement utilisé pour taguer une image Docker. Elle est conçue pour être utilisée dans des workflows Gitea avec des runners auto-hébergés. --- @@ -8,54 +8,45 @@ Elle est conçue pour être utilisée dans des workflows Gitea avec des runners ## 🔧 Utilisation ```yaml -- name: Notify healthchecks - uses: https://gargoton.petite-maison-orange.fr/pmo-actions/healthchecks-ping@main +- name: Get software version + uses: https://gargoton.petite-maison-orange.fr/pmo-actions/software-version@main + id: getversion + with: + version_file: my_version.txt ``` +Le résultat est accessible via `${{ steps.getversion.outputs.version }}`. + --- ## 📥 Paramètres -| Nom | Obligatoire | Par défaut | Description | -|------------------|-------------|------------|-----------------------------------------------------------------------------| -| `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é. | +| Nom | Obligatoire | Par défaut | Description | +|------------------|-------------|--------------------------|-----------------------------------------------------------------------------| +| `git_checkout` | ❌ | `false` | Clone le dépôt courant si activé. Utile si le fichier version est dans le repo. | +| `version_file` | ❌ | `software_version.txt` | Nom du fichier contenant la version du logiciel (1re ligne non vide utilisée). | +| `debug` | ❌ | `false` | Mode débogage. Si activé, affiche des informations détaillées. | --- ## ▶️ Exemple de workflow ```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: Get version + id: getversion + uses: https://gargoton.petite-maison-orange.fr/pmo-actions/software-version@main -- 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 ✅" +- name: Build image + run: echo "Version: ${{ steps.getversion.outputs.version }}" ``` --- ## ⚙️ 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:///ping/` *(commande `stop` ou vide)* - - `https:///ping//` *(commande `start`, `log`, `fail`)* +- Si le fichier spécifié n'existe pas, l'action échoue. +- La première ligne non vide est utilisée comme version. +- Les espaces sont supprimés au début et à la fin, les espaces internes sont remplacés par des tirets. --- @@ -63,4 +54,4 @@ Elle est conçue pour être utilisée dans des workflows Gitea avec des runners 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/) +👉 [https://gargoton.petite-maison-orange.fr/pmo-actions/](https://gargoton.petite-maison-orange.fr/pmo-actions/) \ No newline at end of file