[tutorial v1.1_090] Variable with the value "null"

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_090

Structure

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

Contents of the firefox/20-manual.yml file

%YAML 1.2
---
version: 1.1

manual:

  use_for_https: true  # Also use this proxy for HTTPS

  https_proxy:
    description: HTTPS Proxy
    type: proxy
    hidden:
      variable: _.use_for_https

    address:
      redefine: true
      description: HTTPS proxy address

    port:
      redefine: true
      description: HTTPS proxy port

  socks_proxy:
    description: SOCKS Proxy
    type: proxy

    address:
      redefine: true
      description: SOCKS proxy address
      default: null
      mandatory: false

    port:
      redefine: true
      description: SOCKS proxy port
      default: 1080

    version:
      description: SOCKS host version used by proxy
      choices:
        - v4
        - v5
      default: v5
...

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

---
proxy_mode: Manual proxy configuration
manual:
  http_proxy:
    address: http.proxy.net

Output

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

Note

Caption:

Variable

Unmodifiable variable

Default value

Modified value

(⏳ Original default value)

Variables:

📓 proxy_mode (Configure Proxy Access to the Internet): Manual proxy configuration ← loaded from the YAML file "config/01/config.yml" (⏳ No proxy)
📂 manual (Manual proxy configuration)
- 📂 http_proxy (HTTP Proxy)
  - 📓 address (HTTP proxy address): http.proxy.net ← loaded from the YAML file "config/01/config.yml"
  - 📓 port (HTTP proxy port): 8080
- 📓 use_for_https (Also use this proxy for HTTPS): true
- 📂 https_proxy (HTTPS Proxy)
  - 📓 address (HTTPS proxy address): http.proxy.net
  - 📓 port (HTTPS proxy port): 8080
- 📂 socks_proxy (SOCKS Proxy)
  - 📓 address (SOCKS proxy address): null
  - 📓 port (SOCKS proxy port): 1080
  - 📓 version (SOCKS host version used by proxy): v5

[Next tutorial v1.1_091] Variables disabled when condition is null (diff)

5.5 KiB Raw Blame History