• Summary
• [tutorial v1.1_030] A disabled family (diff)

[tutorial v1.1_031)] A conditional disabled family with a variable

View the diff

Screenshot

Structure

firefox/00-proxy.yml

%YAML 1.2
---
version: 1.1

proxy_mode:
  description: Configure Proxy Access to the Internet
  choices:
    - No proxy
    - Auto-detect proxy settings for this network
    - Use system proxy settings
    - Manual proxy configuration
    - Automatic proxy configuration URL
  default: No proxy
...

firefox/10-manual.yml

%YAML 1.2
---
version: 1.1

manual:
  description: Manual proxy configuration
  disabled:
    variable: _.proxy_mode
    when_not: Manual proxy configuration

  http_proxy:  # HTTP Proxy

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

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

firefox/20-manual.yml

%YAML 1.2
---
version: 1.1

manual:

  use_for_https: true  # Also use this proxy for HTTPS

  https_proxy:  # HTTPS Proxy

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

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

Let's generate the documentation

foo@bar:~$ git switch --detach v1.1_031
foo@bar:~$ 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

Manual proxy configuration

manual

disabled

Disabled: when the variable "proxy_mode" hasn't the value "Manual proxy configuration"

HTTP Proxy

manual.http_proxy

Variable	Description
manual.http_proxy.address domainname mandatory	HTTP address. Validator: the domain name can be an IP
manual.http_proxy.port port mandatory	HTTP Port. Validators: - well-known ports (1 to 1023) are allowed - registred ports (1024 to 49151) are allowed - private ports (greater than 49152) are allowed Default: 8080

Variable	Description
manual.use_for_https boolean mandatory	Also use this proxy for HTTPS. Default: true

HTTPS Proxy

manual.https_proxy

Variable	Description
manual.https_proxy.address domainname mandatory	HTTPS address. Validator: the domain name can be an IP
manual.https_proxy.port port mandatory	HTTPS Port. Validators: - well-known ports (1 to 1023) are allowed - registred ports (1024 to 49151) are allowed - private ports (greater than 49152) are allowed Default: 8080

Let's generate the changelog

foo@bar:~$ git switch --detach v1.1_031
foo@bar:~$ rougail -m firefox/ -o doc --doc.contents changelog

New variables

Variable	Description
manual.http_proxy.address domainname mandatory	HTTP address. Validator: the domain name can be an IP
manual.http_proxy.port port mandatory	HTTP Port. Validators: - well-known ports (1 to 1023) are allowed - registred ports (1024 to 49151) are allowed - private ports (greater than 49152) are allowed Default: 8080
manual.use_for_https boolean mandatory	Also use this proxy for HTTPS. Default: true
manual.https_proxy.address domainname mandatory	HTTPS address. Validator: the domain name can be an IP
manual.https_proxy.port port mandatory	HTTPS Port. Validators: - well-known ports (1 to 1023) are allowed - registred ports (1024 to 49151) are allowed - private ports (greater than 49152) are allowed Default: 8080

User datas

Example 1

config/01/config.yaml

---

Output

foo@bar:~$ git switch --detach v1.1_031
foo@bar:~$ rougail -m firefox/ -u yaml -ff config/01/config.yaml

╭─────── Caption ────────╮
│ Variable Default value │
╰────────────────────────╯
Variables:
┗━━ 📓 Configure Proxy Access to the Internet: No proxy

Output in read write mode

foo@bar:~$ git switch --detach v1.1_031
foo@bar:~$ rougail -m firefox/ -u yaml -ff config/01/config.yaml --cli.read_write

╭─────── Caption ────────╮
│ Variable Default value │
╰────────────────────────╯
Variables:
┗━━ 📓 Configure Proxy Access to the Internet: No proxy

Example 2

config/02/config.yaml

---
proxy_mode: Manual proxy configuration

Output

foo@bar:~$ git switch --detach v1.1_031
foo@bar:~$ rougail -m firefox/ -u yaml -ff config/02/config.yaml

🛑 ERRORS
┗━━ The following variables are mandatory but have no value:
    ┗━━ Manual proxy configuration
        ┣━━ HTTP Proxy
        ┃   ┗━━ HTTP address
        ┗━━ HTTPS Proxy
            ┗━━ HTTPS address

Output in read write mode

foo@bar:~$ git switch --detach v1.1_031
foo@bar:~$ rougail -m firefox/ -u yaml -ff config/02/config.yaml --cli.read_write

🛑 ERRORS
┗━━ The following variables are mandatory but have no value:
    ┗━━ Manual proxy configuration
        ┣━━ HTTP Proxy
        ┃   ┗━━ HTTP address
        ┗━━ HTTPS Proxy
            ┗━━ HTTPS address

Example 3

config/03/config.yaml

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

Output

foo@bar:~$ git switch --detach v1.1_031
foo@bar:~$ rougail -m firefox/ -u yaml -ff config/03/config.yaml

🛑 ERRORS
┗━━ The following variables are mandatory but have no value:
    ┗━━ Manual proxy configuration
        ┗━━ HTTPS Proxy
            ┗━━ HTTPS address

Output in read write mode

foo@bar:~$ git switch --detach v1.1_031
foo@bar:~$ rougail -m firefox/ -u yaml -ff config/03/config.yaml --cli.read_write

🛑 ERRORS
┗━━ The following variables are mandatory but have no value:
    ┗━━ Manual proxy configuration
        ┗━━ HTTPS Proxy
            ┗━━ HTTPS address

Example 4

config/04/config.yaml

---
proxy_mode: Manual proxy configuration
manual:
  http_proxy:
    address: example.net
    port: '3128'

Output

foo@bar:~$ git switch --detach v1.1_031
foo@bar:~$ rougail -m firefox/ -u yaml -ff config/04/config.yaml

🛑 ERRORS
┗━━ The following variables are mandatory but have no value:
    ┗━━ Manual proxy configuration
        ┗━━ HTTPS Proxy
            ┗━━ HTTPS address

Output in read write mode

foo@bar:~$ git switch --detach v1.1_031
foo@bar:~$ rougail -m firefox/ -u yaml -ff config/04/config.yaml --cli.read_write

🛑 ERRORS
┗━━ The following variables are mandatory but have no value:
    ┗━━ Manual proxy configuration
        ┗━━ HTTPS Proxy
            ┗━━ HTTPS address

Example 5

config/05/config.yaml

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

Output

foo@bar:~$ git switch --detach v1.1_031
foo@bar:~$ rougail -m firefox/ -u yaml -ff config/05/config.yaml

╭────────────── Caption ───────────────╮
│ Variable Default value               │
│          Modified value              │
│          (⏳ Original default value) │
╰──────────────────────────────────────╯
Variables:
┣━━ 📓 Configure Proxy Access to the Internet: Manual proxy configuration ◀ loaded from the YAML file "config/05/config.yaml" (⏳ No proxy)
┗━━ 📂 Manual proxy configuration
    ┣━━ 📂 HTTP Proxy
    ┃   ┣━━ 📓 HTTP address: http.proxy.net ◀ loaded from the YAML file "config/05/config.yaml"
    ┃   ┗━━ 📓 HTTP Port: 3128 ◀ loaded from the YAML file "config/05/config.yaml" (⏳ 8080)
    ┣━━ 📓 Also use this proxy for HTTPS: false ◀ loaded from the YAML file "config/05/config.yaml" (⏳ true)
    ┗━━ 📂 HTTPS Proxy
        ┣━━ 📓 HTTPS address: https.proxy.net ◀ loaded from the YAML file "config/05/config.yaml"
        ┗━━ 📓 HTTPS Port: 8080

Output in read write mode

foo@bar:~$ git switch --detach v1.1_031
foo@bar:~$ rougail -m firefox/ -u yaml -ff config/05/config.yaml --cli.read_write

╭────────────── Caption ───────────────╮
│ Variable Default value               │
│          Modified value              │
│          (⏳ Original default value) │
╰──────────────────────────────────────╯
Variables:
┣━━ 📓 Configure Proxy Access to the Internet: Manual proxy configuration ◀ loaded from the YAML file "config/05/config.yaml" (⏳ No proxy)
┗━━ 📂 Manual proxy configuration
    ┣━━ 📂 HTTP Proxy
    ┃   ┣━━ 📓 HTTP address: http.proxy.net ◀ loaded from the YAML file "config/05/config.yaml"
    ┃   ┗━━ 📓 HTTP Port: 3128 ◀ loaded from the YAML file "config/05/config.yaml" (⏳ 8080)
    ┣━━ 📓 Also use this proxy for HTTPS: false ◀ loaded from the YAML file "config/05/config.yaml" (⏳ true)
    ┗━━ 📂 HTTPS Proxy
        ┣━━ 📓 HTTPS address: https.proxy.net ◀ loaded from the YAML file "config/05/config.yaml"
        ┗━━ 📓 HTTPS Port: 8080

• [tutorial v1.1_041] An hidden family (diff)