rougail-tutorials/README.md

• Summary
• [tutorial v1.1_041] A default value calculated from another variable (diff)

[tutorial v1.1_050] A disabled family

View the diff

Read the documentation

Screenshot

Clone and install

To test this tutorial, you need to download this repository and install Rougail:

git clone -b 1.1 https://forge.cloud.silique.fr/stove/rougail-tutorials.git
cd rougail-tutorials
python -m venv venv_rougail
. venv_rougail/bin/activate
pip install rougail-cli rougail-output-exporter rougail-output-doc rougail-user-data-yaml

Then switch to the tutorial page:

git switch --detach v1.1_050

Structure

.
└── firefox
    ├── 00-proxy.yml
    ├── 10-manual.yml
    └── 20-manual.yml

Contents of the firefox/10-manual.yml file

%YAML 1.2
---
version: 1.1

manual:
  description: Manual proxy configuration
  disabled: true

  http_proxy:  # HTTP Proxy

    address:
      description: HTTP address
      type: domainname
      params:
        allow_ip: true

    port:
      description: HTTP Port
      type: port
      default: 8080
...

---

Let's generate the documentation

rougail -m firefox/ -o doc

Variable	Description
proxy_mode choice mandatory	Configure Proxy Access to the Internet. Choices: • No proxy ← (default) • Auto-detect proxy settings for this network • Use system proxy settings • Manual proxy configuration • Automatic proxy configuration URL

---

Let's generate the changelog

rougail -m firefox/ -o doc --doc.contents changelog

Deleted variables

• manual.http_proxy.address
• manual.http_proxy.port
• manual.use_for_https
• manual.https_proxy.address
• manual.https_proxy.port

---

User datas

Example 1

config/01/config.yml

---

---

Output

rougail -m firefox/ -u yaml -yf config/01/config.yml

Note

Caption:

• Variable
• Default value

Variables:

• 📓 proxy_mode (Configure Proxy Access to the Internet): No proxy

---

Example 2

config/02/config.yml

---
proxy_mode: Manual proxy configuration
manual:
  http_proxy:
    address: http.proxy.net
    port: 3128
  use_for_https: false

---

Output

rougail -m firefox/ -u yaml -yf config/02/config.yml

Warning

• manual (Manual proxy configuration)
  • http_proxy (HTTP Proxy)
    • address (HTTP address): 🔔 family "manual" (Manual proxy configuration) has property disabled, so cannot access to "address" (HTTP address), it will be ignored when loading from the YAML file "config/02/config.yml"
    • port (HTTP Port): 🔔 family "manual" (Manual proxy configuration) has property disabled, so cannot access to "port" (HTTP Port), it will be ignored when loading from the YAML file "config/02/config.yml"
  • use_for_https (Also use this proxy for HTTPS): 🔔 family "manual" (Manual proxy configuration) has property disabled, so cannot access to "use_for_https" (Also use this proxy for HTTPS), it will be ignored when loading from the YAML file "config/02/config.yml"

Note

Caption:

• Variable
• Modified value
• (⏳ Original default value)

Variables:

• 📓 proxy_mode (Configure Proxy Access to the Internet): Manual proxy configuration ← loaded from the YAML file "config/02/config.yml" (⏳ No proxy)

---

Output when unknown user data is an error

rougail -m firefox/ -u yaml -yf config/02/config.yml --cli.unknown_user_data_error

Caution

• manual (Manual proxy configuration)
  • http_proxy (HTTP Proxy)
    • address (HTTP address): 🛑 family "manual" (Manual proxy configuration) has property disabled, so cannot access to "address" (HTTP address), it has been loading from the YAML file "config/02/config.yml"
    • port (HTTP Port): 🛑 family "manual" (Manual proxy configuration) has property disabled, so cannot access to "port" (HTTP Port), it has been loading from the YAML file "config/02/config.yml"
  • use_for_https (Also use this proxy for HTTPS): 🛑 family "manual" (Manual proxy configuration) has property disabled, so cannot access to "use_for_https" (Also use this proxy for HTTPS), it has been loading from the YAML file "config/02/config.yml"

---

• [tutorial v1.1_051] A conditional disabled family (diff)