Actualiser README.md

This commit is contained in:
2025-12-26 12:43:12 +01:00
parent bb5608040f
commit 3a1f1b64eb

View File

@@ -1,13 +1,10 @@
# L'action `push-image` # L'action `push-image`
Cette action permet de pousser une image Docker dans un registre à l'aide des outils `docker`, `podman` ou `skopeo`.
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. Elle est conçue pour être utilisée dans des workflows Gitea avec des runners auto-hébergés.
--- ---
## 🔧 Utilisation ## 🔧 Utilisation
```yaml ```yaml
- name: Build and push Docker image - name: Build and push Docker image
uses: https://gargoton.petite-maison-orange.fr/pmo-actions/push-image@main uses: https://gargoton.petite-maison-orange.fr/pmo-actions/push-image@main
@@ -15,10 +12,10 @@ Elle est conçue pour être utilisée dans des workflows Gitea avec des runners
image_name: my_image image_name: my_image
image_tags: latest stable image_tags: latest stable
``` ```
--- ---
## 📥 Paramètres ## 📥 Paramètres
| Nom | Obligatoire | Par défaut | Description | | Nom | Obligatoire | Par défaut | Description |
|-------------------|-------------|-------------------------------------|---------------------------------------------------------------------------------| |-------------------|-------------|-------------------------------------|---------------------------------------------------------------------------------|
| `image_name` | ✅ | | Nom de l'image à pousser. | | `image_name` | ✅ | | Nom de l'image à pousser. |
@@ -27,13 +24,14 @@ Elle est conçue pour être utilisée dans des workflows Gitea avec des runners
| `registry_user` | ❌ | `${{ secrets.PMO_REGISTRY_USER }}` | Utilisateur pour se connecter au registre. | | `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_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. | | `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`). | | `push_command` | ❌ | `podman` | Commande à utiliser pour pousser l'image (`docker`, `podman` ou `skopeo`). |
| `debug` | ❌ | `false` | Mode débogage. Si activé, affiche des informations détaillées pendant l'exécution. | | `debug` | ❌ | `false` | Mode débogage. Si activé, affiche des informations détaillées pendant l'exécution. |
--- ---
## ▶️ Exemple de workflow ## ▶️ Exemples de workflow
### Avec Docker
```yaml ```yaml
- name: Push Docker image - name: Push Docker image
uses: https://gargoton.petite-maison-orange.fr/pmo-actions/push-image@main uses: https://gargoton.petite-maison-orange.fr/pmo-actions/push-image@main
@@ -48,6 +46,17 @@ Elle est conçue pour être utilisée dans des workflows Gitea avec des runners
debug: true debug: true
``` ```
### Avec Skopeo
```yaml
- name: Push Docker image with Skopeo
uses: https://gargoton.petite-maison-orange.fr/pmo-actions/push-image@main
with:
image_name: public/pmomusic
image_tags: latest v1.0.0
registry_login: true
push_command: skopeo
```
--- ---
## ⚙️ Comportement ## ⚙️ Comportement
@@ -57,6 +66,11 @@ Elle est conçue pour être utilisée dans des workflows Gitea avec des runners
- L'image est poussée sous chaque tag spécifié dans le paramètre `image_tags`. - 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. - Si `debug` est activé, des informations détaillées sont affichées pendant le processus.
### Différences entre les commandes
- **`docker` et `podman`** : Utilisent la syntaxe classique `push <registry>/<image>:<tag>`
- **`skopeo`** : Utilise la syntaxe `copy docker-daemon:<image> docker://<registry>/<image>` pour copier l'image depuis le daemon local vers le registre distant
--- ---
## 🧡 À propos ## 🧡 À propos