diff --git a/README.md b/README.md new file mode 100644 index 0000000..b2b139f --- /dev/null +++ b/README.md @@ -0,0 +1,29 @@ +# 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. + +Pour les inclures utiliser la syntaxe: + +```yaml + uses: https://gargoton.petite-maison-orange.fr/pmo-actions/ACTION@main +``` + +En remplaçant `ACTION` par l'action désirée. + +## L'action `healthchecks-ping` + +Elle apour 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. + +- `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`. + +- `message`: Le message qui sera logguer lors du ping sur le serveur [`healthchecks.io`](https://healthchecks.io/). + +