Update readme

This commit is contained in:
Maniack Crudelis 2017-10-24 21:32:39 +02:00
parent 33f261d858
commit 2ec5834a98
2 changed files with 16 additions and 0 deletions

View file

@ -50,6 +50,9 @@ package_check/package_check.sh APP_ynh
``` ```
;; Nom du test ;; Nom du test
# Commentaire ignoré # Commentaire ignoré
; pre-install
echo -n "Placez ici vos commandes a exéxuter dans le conteneur, "
echo "avant chaque installation de l'application."
; Manifest ; Manifest
domain="domain.tld" (DOMAIN) domain="domain.tld" (DOMAIN)
path="/path" (PATH) path="/path" (PATH)
@ -91,6 +94,11 @@ Nom du scénario de test qui sera effectué.
On peut créer autant de scénario de test que voulu, tous ayant la même syntaxe. On peut créer autant de scénario de test que voulu, tous ayant la même syntaxe.
Les différents scénarios de test seront exécutés successivement. Les différents scénarios de test seront exécutés successivement.
### `; pre-install`
*Instruction optionnelle*
Si vous devez exécuter une commande ou un groupe de commandes avant l'installation, vous pouvez utiliser cette instruction.
Toutes les commandes ajoutées après l'instruction `; pre-install` seront exécutées dans le conteneur avant chaque installation de l'application.
### `; Manifest` ### `; Manifest`
Ensemble des clés du manifest. Ensemble des clés du manifest.
Toutes les clés du manifest doivent être renseignée afin de procéder à l'installation. Toutes les clés du manifest doivent être renseignée afin de procéder à l'installation.

View file

@ -50,6 +50,9 @@ package_check/package_check.sh APP_ynh
``` ```
;; Test name ;; Test name
# Comment ignored # Comment ignored
; pre-install
echo -n "Here your commands to execute in the container, "
echo "before each installation of the app."
; Manifest ; Manifest
domain="domain.tld" (DOMAIN) domain="domain.tld" (DOMAIN)
path="/path" (PATH) path="/path" (PATH)
@ -91,6 +94,11 @@ Name of tests series that will be perform.
It's possible to create multiples tests series, all with the same syntax. It's possible to create multiples tests series, all with the same syntax.
All different tests series will be perform sequentialy. All different tests series will be perform sequentialy.
### `; pre-install`
*Optionnal instruction*
If you have to execute a command or a group of commands before the installation. You can use this instruction.
All the commands added after the instruction `; pre-install` will be executed in the container before each installation of the app.
### `; Manifest` ### `; Manifest`
Set of manifest keys. Set of manifest keys.
All manifest keys need to be filled to perform installation. All manifest keys need to be filled to perform installation.