From d5d53367dabaef2bae29f3af9e80ba26b5907f4c 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 -> 1747 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..25b6379 --- /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 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..8551fb6 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:16+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..fea2ee1 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:16+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..a4a0398440a3da0fb6286640844ba03b5b1f701a 100644 GIT binary patch literal 1747 zcmaJ>&yO256gIH@3Kv?$0RiGQ0`|a8nxrb)1`wj9MJr`t1zQ9saA#gJ29G`1o(-dF z#f3irA#q1SLJBvIT)51Y3;zHY#2>){iO(}hv%72=$@yktzvu6LexLuixb>aD^906o z7y;t~#%~z$dGY}vE&(q9kAYW!F93fAj)A`ep9gL|D1-#|f!Bav178OI3VaIq7w{7B zZ{R<`XCD&cCEzn#Li_-H6ZkstPv8_t4-4@kumFAq{1&(my!eO^mw}%Gp9X#d+yVXw z1Qqc(Mtpi0v8MPSrFg7;>wZ9?eICUx(h7tM(CME3-QjVcl%cz$W6Gr`X{a)v8@n)c zBz48&dQBP6WTnFnNv&z7G_K!uv;f$lI>o@bS&U}Lm0Ooeq! zrQ=k2)-^41mFDLp3psnfmr~rwrJJ|e9Az>{nmJq0$8YUV+gNc6Y{+6xA#<>N!TLzxccsRbAjK<0M8jZ%2(W|cvN5f%nDt$-}oitucsEo*|H1kT%IXPrmocNyL z1bh2?`!_ecj0VHr4fGNl_9Y2uGbSP>p6#*Y*5xT8eHvtl&ls+jt7=A73j)fw6#^s(kzRZ?~97{|80|=*k9`YxZr&h<9z_Bb!x8vBSZnWEU(9Mz;BdJWh((IG!sXFnQmN#B`IVEj->A zXJru|C@6hu6ZQ}UB14VyM3zUKlHT4p?yMJKgh(;=&AeHnoOq~u8}35|YcoQ71z86I zr`(ZiFB;d`Wrws}AHI`myuQqKzV>`31E|vQvIpf=Z0or;Xh5!Hn delta 358 zcmZ|JF-yZh7=YnRo5qSLT9Gamu288|BQaR89nC0qb8|UKtiiT{w4pe;IE!#NDfkoo z4Q@KAxQd&Tn;^IdzUSuP2QN>OyIk@-eO)|xE!h`>DbgbC(G*>gnLDb|J=N%)e44d{ zs9=CCR5*{9Sj8Ls#wT3Dhnx^~{KRdntbrI9o%(yR>i zm(|dxxwd}G?az2kcYQ;8n{B_f;`w?ve`_^$*O&UPDh_R F!4FZMNKF6$