software-version/README.md

# L'action `software-version`

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.

---

## 🔧 Utilisation

```yaml
- 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                                                                 |
|------------------|-------------|--------------------------|-----------------------------------------------------------------------------|
| `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: Get version
  id: getversion
  uses: https://gargoton.petite-maison-orange.fr/pmo-actions/software-version@main

- name: Build image
  run: echo "Version: ${{ steps.getversion.outputs.version }}"
```

---

## ⚙️ Comportement

- 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.

---

## 🧡 À 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/)