• Summary
• [tutorial v1.1_101] A variable with multiple value (diff)

[tutorial v1.1_102] A non mandatory variable

Read the tutorial "A non mandatory variable" in 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_102

Structure

.
├── firefox
│   ├── 00-proxy.yml
│   ├── 10-manual.yml
│   ├── 20-manual.yml
│   ├── 30-auto.yml
│   └── 40-no_proxy.yml
└── types
    └── proxy
        └── 00-type.yml

Contents of the firefox/40-no_proxy.yml file

%YAML 1.2
---
version: 1.1

no_proxy:
  description: Address for which proxy will be desactivated
  type: domainname
  params:
    allow_ip: true
    allow_cidr_network: true
    allow_without_dot: true
    allow_startswith_dot: true
  multi: true
  mandatory: false
  disabled:
    variable: _.proxy_mode
    when: No proxy
...

---

Let's generate the documentation

rougail -m firefox/ --types types/proxy -o doc

View the documentation file

---

Let's generate the changelog

rougail -m firefox/ --types types/proxy -o doc --doc.contents changelog --doc.changelog.previous_json_file previous.yml

View the changelog file

---

User datas

Example 1

config/01/config.yml

---

---

Output

rougail -m firefox/ --types types/proxy -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: Automatic proxy configuration URL
auto: https://auto.proxy.net/wpad.dat
no_proxy:
  - example.net
  - 192.168.1.0/24

---

Output

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

Note

Caption:

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

Variables:

• 📓 proxy_mode (Configure Proxy Access to the Internet): Automatic proxy configuration URL ← loaded from the YAML file "config/02/config.yml" (⏳ No proxy)
• 📓 auto (Automatic proxy configuration URL): https://auto.proxy.net/wpad.dat ← loaded from the YAML file "config/02/config.yml"
• 📓 no_proxy (Address for which proxy will be desactivated):
  • example.net ← loaded from the YAML file "config/02/config.yml"
  • 192.168.1.0/24 ← loaded from the YAML file "config/02/config.yml"

---

Example 3

config/03/config.yml

---
proxy_mode: Automatic proxy configuration URL
auto: https://auto.proxy.net/wpad.dat

---

Output

rougail -m firefox/ --types types/proxy -u yaml -yf config/03/config.yml

Note

Caption:

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

Variables:

• 📓 proxy_mode (Configure Proxy Access to the Internet): Automatic proxy configuration URL ← loaded from the YAML file "config/03/config.yml" (⏳ No proxy)
• 📓 auto (Automatic proxy configuration URL): https://auto.proxy.net/wpad.dat ← loaded from the YAML file "config/03/config.yml"
• 📓 no_proxy (Address for which proxy will be desactivated): []

---

• [tutorial v1.1_103] Examples (diff)