Actualiser README.md

2025-04-14 12:49:47 +02:00
parent ebd799e9cf
commit ff6c5f10a6
1 changed files with 42 additions and 16 deletions
--- a/README.md
+++ b/README.md
@@ -1,29 +1,55 @@
-# Les pmo-actions

-Les actions de la *petite maison orange* sont des actions réutilisables dans un environnement Gitea.
-Elles sont avant tout faites pour me faciliter la vie dans la gestion de mon nuage personnel.
+# L'action `registry-login`

-Pour les inclures utiliser la syntaxe:
+Cette action permet de se connecter à un registre Docker (ou Podman).  
+Elle est conçue pour être utilisée dans des workflows Gitea avec des runners auto-hébergés.
+
+---
+
+## 🔧 Utilisation

 ```yaml
-        uses: https://gargoton.petite-maison-orange.fr/pmo-actions/ACTION@main
+- name: Connect to Docker registry
+  uses: https://gargoton.petite-maison-orange.fr/pmo-actions/registry-login@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 
-quatre valeurs en entrée, dont deux premières sont obligatoires.
+| Nom               | Obligatoire | Par défaut                | Description                                                                      |
+|-------------------|-------------|---------------------------|----------------------------------------------------------------------------------|
+| `registry_command` | ❌           | `podman`                  | Commande utilisée pour la connexion (ex : `docker` ou `podman`).                 |
+| `registry_server`  | ❌           | `niepce.petite-maison-orange.fr` | Adresse du serveur du registre Docker.                                           |
+| `registry_user`    | ❌           | `${{ secrets.PMO_REGISTRY_USER }}` | Nom d’utilisateur pour la connexion.                                             |
+| `registry_password`| ❌           | `${{ secrets.PMO_REGISTRY_PASSWORD }}` | Mot de passe pour la connexion.                                                  |
+| `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: Connect to Docker registry
+  uses: https://gargoton.petite-maison-orange.fr/pmo-actions/registry-login@main
+  with:
+    registry_server: niepce.petite-maison-orange.fr
+    registry_user: ${{ secrets.PMO_REGISTRY_USER }}
+    registry_password: ${{ secrets.PMO_REGISTRY_PASSWORD }}
+```

+---

+## ⚙️ Comportement
+
+- Si l’action réussit, un message de succès est affiché.
+- Si l’action échoue (par exemple, si la connexion au registre échoue), un message d’erreur est affiché et l’action échoue également.
+- L'action utilise la commande `login` pour établir la connexion au registre avec l'utilisateur et le mot de passe fournis.
+
+---
+
+## 🧡 À 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/)