From 420e5f4cd50f6c95a205817c63ae0e22e8073d68 Mon Sep 17 00:00:00 2001 From: Eric Coissac Date: Mon, 14 Apr 2025 13:42:11 +0200 Subject: [PATCH] Actualiser README.md --- README.md | 64 +++++++++++++++++++++++++++---------------------------- 1 file changed, 32 insertions(+), 32 deletions(-) diff --git a/README.md b/README.md index cf4e541..f28aaba 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,7 @@ -# L'action `healthchecks-ping` -Cette action permet d’envoyer un *ping* vers un serveur [Healthchecks.io](https://healthchecks.io) (ou un serveur compatible). +# L'action `push-image` + +Cette action permet de pousser une image Docker dans un registre à l'aide des outils `docker` ou `podman`. Elle est conçue pour être utilisée dans des workflows Gitea avec des runners auto-hébergés. --- @@ -8,54 +9,53 @@ 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: Build and push Docker image + uses: https://gargoton.petite-maison-orange.fr/pmo-actions/push-image@main + with: + image_name: my_image + image_tags: latest stable ``` - --- ## 📥 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 | +|-------------------|-------------|-------------------------------------|---------------------------------------------------------------------------------| +| `image_name` | ✅ | – | Nom de l'image à pousser. | +| `image_tags` | ✅ | – | Liste des tags à ajouter à l'image avant de la pousser. | +| `registry_login` | ❌ | `false` | Indique si l'action doit se connecter au registre avant de pousser l'image. | +| `registry_user` | ❌ | `${{ secrets.PMO_REGISTRY_USER }}` | Utilisateur pour se connecter au registre. | +| `registry_password`| ❌ | `${{ secrets.PMO_REGISTRY_PASSWORD }}`| Mot de passe pour se connecter au registre. | +| `registry_server` | ❌ | `niepce.petite-maison-orange.fr` | Adresse du serveur du registre d'images Docker. | +| `push_command` | ❌ | `podman` | Commande à utiliser pour pousser l'image (`docker` ou `podman`). | +| `debug` | ❌ | `false` | Mode débogage. Si activé, affiche des informations détaillées pendant l'exécution. | --- ## ▶️ Exemple de workflow ```yaml -- name: Notify healthchecks (start) - uses: https://gargoton.petite-maison-orange.fr/pmo-actions/healthchecks-ping@main +- name: Push Docker image + uses: https://gargoton.petite-maison-orange.fr/pmo-actions/push-image@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 ✅" + image_name: my_image + image_tags: latest stable + registry_login: true + registry_user: ${{ secrets.PMO_REGISTRY_USER }} + registry_password: ${{ secrets.PMO_REGISTRY_PASSWORD }} + registry_server: niepce.petite-maison-orange.fr + push_command: docker + debug: true ``` --- ## ⚙️ 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 l'option `registry_login` est activée, l'action se connecte au registre avant de pousser l'image. +- Si la commande `push_command` échoue, l'action renvoie une erreur. +- L'image est poussée sous chaque tag spécifié dans le paramètre `image_tags`. +- Si `debug` est activé, des informations détaillées sont affichées pendant le processus. ---