From d7fccac742cd9107166adb0315d42832264ca2a5 Mon Sep 17 00:00:00 2001 From: Emmanuel Garette Date: Mon, 29 Dec 2025 12:15:56 +0100 Subject: [PATCH] fix: doc --- README.fr.md | 20 +++++++++ README.md | 20 ++++++++- .../fr/LC_MESSAGES/rougail_user_data_yaml.po | 40 ++++++++++++++---- locale/rougail_user_data_yaml.pot | 20 +++++++-- src/rougail/user_data_yaml/config.py | 14 +++--- .../fr/LC_MESSAGES/rougail_user_data_yaml.mo | Bin 1055 -> 1749 bytes 6 files changed, 95 insertions(+), 19 deletions(-) create mode 100644 README.fr.md diff --git a/README.fr.md b/README.fr.md new file mode 100644 index 0000000..6e675be --- /dev/null +++ b/README.fr.md @@ -0,0 +1,20 @@ +--- +gitea: none +include_toc: true +--- +[🇬🇧 (EN)](README.md) - [🇫🇷 (FR)](README.fr.md) + +## Charger les données utilisateur à partir d'un fichier YAML + +> [!NOTE] +> +> **Chemin** : yaml\ +> *`désactivé`*\ +> **Désactivé** : si "[Charger les données utilisateur à partir d'un fichier YAML](#yaml)" n'est pas défini dans "[Sélection pour données utilisateur](#step.user_data)" + +| Variable | Description | Valeur par défaut | Type | Validateur | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------|--------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **yaml.filename**
**Ligne de commande** :
-yf, --yaml.filename
**Variable d'environnement** : YAML.FILENAME | Noms de fichier ou répertoire où sont enregistré les données utilisateur.
Si un répertoire est défini, tous les fichiers avec l'extension "yml" ou "yaml" seront chargés dans l'ordre alphanumérique. | | [`UNIX filename`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `multiple` `obligatoire` | `unique`
• le nom de fichier peut être une chemin relatif
• le fichier doit exister
• type de fichier autorisé: "fichier" et "répertoire". | +| **yaml.file_with_secrets**
**Ligne de commande** :
--yaml.file_with_secrets
**Variable d'environnement** : YAML.FILE_WITH_SECRETS | Le fichier peut contenir des secrets.
Par défaut, tous les fichiers peuvent contenir des secrets. Il peut être intéressant de définir plus précisément quels fichiers peuvent contenir ces secrets. | all | [`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` | **Choix** :
• all
• first
• last
• none | + + diff --git a/README.md b/README.md index 39eed9a..6bfbb88 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,20 @@ -# rougail-user-data-yaml +--- +gitea: none +include_toc: true +--- +[🇬🇧 (EN)](README.md) - [🇫🇷 (FR)](README.fr.md) + +## Charge user data from YAML file + +> [!NOTE] +> +> **Path**: yaml\ +> *`disabled`*\ +> **Disabled**: if yaml is not set in "[Select for user datas](#step.user_data)" + +| Variable | Description | Default value | Type | Validator | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------|------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------| +| **yaml.filename**
**Command line**:
-yf, --yaml.filename
**Environment variable**: YAML.FILENAME | File or directory names where user data are stored.
If a directory is set, all files with "yml" ou "yaml" extension will be load with alphanum order. | | [`UNIX filename`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `multiple` `mandatory` | `unique`
• this filename could be a relative path
• this file must exist
• file type allowed: "directory" and "file". | +| **yaml.file_with_secrets**
**Command line**:
--yaml.file_with_secrets
**Environment variable**: YAML.FILE_WITH_SECRETS | File that may contain secrets.
By default, all files can contain secrets. It might be useful to define more precisely which files can contain these secrets. | all | [`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | **Choices**:
• all
• first
• last
• none | + diff --git a/locale/fr/LC_MESSAGES/rougail_user_data_yaml.po b/locale/fr/LC_MESSAGES/rougail_user_data_yaml.po index a30893d..2780f49 100644 --- a/locale/fr/LC_MESSAGES/rougail_user_data_yaml.po +++ b/locale/fr/LC_MESSAGES/rougail_user_data_yaml.po @@ -5,8 +5,8 @@ msgid "" msgstr "" "Project-Id-Version: \n" -"POT-Creation-Date: 2025-05-14 08:28+0200\n" -"PO-Revision-Date: 2025-05-14 08:29+0200\n" +"POT-Creation-Date: 2025-12-29 12:15+0100\n" +"PO-Revision-Date: 2025-12-29 12:15+0100\n" "Last-Translator: \n" "Language-Team: \n" "Language: fr\n" @@ -14,13 +14,13 @@ msgstr "" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" "Generated-By: pygettext.py 1.5\n" -"X-Generator: Poedit 3.5\n" +"X-Generator: Poedit 3.8\n" #: src/rougail/user_data_yaml/__init__.py:46 msgid "yaml is not set in step.user_data" msgstr "\"yaml\" n'est pas défini dans step.user_data" -#: src/rougail/user_data_yaml/__init__.py:72 +#: src/rougail/user_data_yaml/__init__.py:74 msgid "cannot load \"{0}\", the root value is not a dict but \"{1}\"" msgstr "" "ne peut charger \"{0}\", la valeur racine n'est pas une dictionnaire mais " @@ -35,17 +35,41 @@ msgid "\"{0}\" in {1} has an unknown value" msgstr "\"{0}\" dans {1} a une valeur inconnue" #: src/rougail/user_data_yaml/config.py:30 -msgid "Configuration rougail-user-data-yaml" -msgstr "Configuration de rougail-user-data-yaml" +msgid "Charge user data from YAML file" +msgstr "Charger les données utilisateur à partir d'un fichier YAML" + +#: src/rougail/user_data_yaml/config.py:35 +msgid "if yaml is not set in \"step.user_data\"" +msgstr "si \"yaml\" n'est pas défini dans \"step.user_data\"" + +#: src/rougail/user_data_yaml/config.py:38 +msgid "File or directory names where user data are stored" +msgstr "" +"Noms de fichier ou répertoire où sont enregistré les données utilisateur" #: src/rougail/user_data_yaml/config.py:39 -msgid "File or directory name where user datas are stored" +msgid "" +"If a directory is set, all files with \"yml\" ou \"yaml\" extension will be " +"load with alphanum order." msgstr "" -"Nom du fichier ou répertoire où sont enregistré les données utilisateur" +"Si un répertoire est défini, tous les fichiers avec l'extension \"yml\" ou " +"\"yaml\" seront chargés dans l'ordre alphanumérique." #: src/rougail/user_data_yaml/config.py:48 msgid "File that may contain secrets" msgstr "Le fichier peut contenir des secrets" +#: src/rougail/user_data_yaml/config.py:49 +msgid "" +"By default, all files can contain secrets. It might be useful to define more " +"precisely which files can contain these secrets." +msgstr "" +"Par défaut, tous les fichiers peuvent contenir des secrets. Il peut être " +"intéressant de définir plus précisément quels fichiers peuvent contenir ces " +"secrets." + +#~ msgid "Configuration rougail-user-data-yaml" +#~ msgstr "Configuration de rougail-user-data-yaml" + #~ msgid "Filename" #~ msgstr "Nom du fichier" diff --git a/locale/rougail_user_data_yaml.pot b/locale/rougail_user_data_yaml.pot index 7358ec7..3670e48 100644 --- a/locale/rougail_user_data_yaml.pot +++ b/locale/rougail_user_data_yaml.pot @@ -5,7 +5,7 @@ msgid "" msgstr "" "Project-Id-Version: PACKAGE VERSION\n" -"POT-Creation-Date: 2025-05-14 08:29+0200\n" +"POT-Creation-Date: 2025-12-29 12:15+0100\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -19,7 +19,7 @@ msgstr "" msgid "yaml is not set in step.user_data" msgstr "" -#: src/rougail/user_data_yaml/__init__.py:72 +#: src/rougail/user_data_yaml/__init__.py:74 msgid "cannot load \"{0}\", the root value is not a dict but \"{1}\"" msgstr "" @@ -32,14 +32,26 @@ msgid "\"{0}\" in {1} has an unknown value" msgstr "" #: src/rougail/user_data_yaml/config.py:30 -msgid "Configuration rougail-user-data-yaml" +msgid "Charge user data from YAML file" +msgstr "" + +#: src/rougail/user_data_yaml/config.py:35 +msgid "if yaml is not set in \"step.user_data\"" +msgstr "" + +#: src/rougail/user_data_yaml/config.py:38 +msgid "File or directory names where user data are stored" msgstr "" #: src/rougail/user_data_yaml/config.py:39 -msgid "File or directory name where user datas are stored" +msgid "If a directory is set, all files with \"yml\" ou \"yaml\" extension will be load with alphanum order." msgstr "" #: src/rougail/user_data_yaml/config.py:48 msgid "File that may contain secrets" msgstr "" +#: src/rougail/user_data_yaml/config.py:49 +msgid "By default, all files can contain secrets. It might be useful to define more precisely which files can contain these secrets." +msgstr "" + diff --git a/src/rougail/user_data_yaml/config.py b/src/rougail/user_data_yaml/config.py index 13dfb5d..963fcc6 100644 --- a/src/rougail/user_data_yaml/config.py +++ b/src/rougail/user_data_yaml/config.py @@ -27,15 +27,16 @@ def get_rougail_config( ) -> dict: options = f""" yaml: - description: {_("Configuration rougail-user-data-yaml")} + description: {_("Charge user data from YAML file")} disabled: - jinja: | - {{% if step.user_data is propertyerror or 'yaml' not in step.user_data %}} - disabled - {{% endif %}} + jinja: >- + {{{{ step.user_data is not propertyerror or 'yaml' not in step.user_data }}}} + return_type: boolean + description: {_('if yaml is not set in "step.user_data"')} filename: - description: {_("File or directory name where user datas are stored")} + description: {_("File or directory names where user data are stored")} + help: {_('If a directory is set, all files with "yml" ou "yaml" extension will be load with alphanum order.')} alternative_name: yf type: unix_filename multi: true @@ -45,6 +46,7 @@ yaml: file_with_secrets: description: {_("File that may contain secrets")} + help: {_('By default, all files can contain secrets. It might be useful to define more precisely which files can contain these secrets.')} default: all choices: - all diff --git a/src/rougail/user_data_yaml/locale/fr/LC_MESSAGES/rougail_user_data_yaml.mo b/src/rougail/user_data_yaml/locale/fr/LC_MESSAGES/rougail_user_data_yaml.mo index 8314ce55873a6362f4e7b79f31f941a711cab657..32bb1b8cf96452681040e6d7ade4bd3d46db89ec 100644 GIT binary patch literal 1749 zcmaJ>O^+ir5H&D-g$uig0|G>C1k8cyY?9STvjK$IWfzT{Fo3U;2q$z@qgeB@JAr1 zh$k`P)5C~0#RnUgX_2cmzaUx2+4KFB;$|-0yv^n)lR?tV*@8ZO`(WC}irZjA7IO-jgLO3-S%BXn zXKV)&t1yW#k9p3zkdRA|mG$`|#Qu!rscg!F%bCg-D&*9!3*9GM;YG$b{wlEX${JcI zXoUK;l^H&;R_ZdBrYb-)V>b|x&e+f`XyxA_6iv?J&sK86rg25&kwVNWP#?$B7ivav zyY)PX#gps%z~vy8`dL({FJiX)3Lz9HEG~#U8zv5&{Tvb|`&sfayI9MFdWY{PAMmk? zU&%W%@Px+0@oq92C*$ih8c#;MuMJ1TVQ(sZNRFH|UQ4Kq$f-2*O3pbsVp*K}p5O#~ z2m1%NHoJ@l!`@Bw5*y^GOKcLL=haf9xn8Ff9e_&T{OIU*vbR|m_nNUwZkg0(%FHLU zcUOhpyKLBjXqMclCsfvR4l&uFtZ6jZ?R}E07DSGRmNOOT+F-9IIv-?6+ByN+SLj(B z2UiXvqty+(a46AE%@S@vO9Weaie8wZlNBVRlB;7B(e@M@g|(R7xI@PUftsHJno*h1 zEFF6<5s-14R>hc7BW>xLC5+N6iUOolcy~_-WTU( z5g#fjeP$E(5CkGajf+H<$DESh-Z<{O7h!}*G4{>8S)!bHsCpajLj`LyLVE>S2Lh+u zk!vp+*V$!f%K%i*zyib|2eJY&2(SY&P?~`a#F@;=sHNhZpO==IURsn`l9`{U zP?TSqo|u`VTUwl2q??jhlBipmn42^C0;9N~LU~4NQK|w+Mgb&KJoyKs*5no@tI1E9 zlK2cvbq!4v3@ogSEVT`cCWkT~WHg;D&Z41*YJN&84l5Y^@^ckZN++wcW=|Gk^P4=0 G%^3hxa7a-A