26 KiB
26 KiB
[tutorial v1.1_027)] A conditional disabled family with a variable
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
...
Let's generate the documentation
foo@bar:~$ git switch --detach v1.1_027
foo@bar:~$ rougail -m firefox/ -o doc -do github
| Variable | Description |
|---|---|
proxy_modechoice 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.addressdomainname mandatory |
HTTP address. Validator: the domain name can be an IP |
manual.http_proxy.portport 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 |
Let's generate the changelog
foo@bar:~$ git switch --detach v1.1_027
foo@bar:~$ rougail -m firefox/ -o doc --doc.contents changelog -do github
New variables
| Variable | Description |
|---|---|
manual.http_proxy.addressdomainname mandatory |
HTTP address. Validator: the domain name can be an IP |
manual.http_proxy.portport 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 |
User datas
Example 1
config/01/config.yaml
---
Output
foo@bar:~$ git switch --detach v1.1_027
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_027
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_027
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
Output in read write mode
foo@bar:~$ git switch --detach v1.1_027
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
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_027
foo@bar:~$ rougail -m firefox/ -u yaml -ff config/03/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/03/config.yaml" (⏳ No proxy) ┗━━ 📂 Manual proxy configuration ┗━━ 📂 HTTP Proxy ┣━━ 📓 HTTP address: example.net ◀ loaded from the YAML file "config/03/config.yaml" ┗━━ 📓 HTTP Port: 8080
Output in read write mode
foo@bar:~$ git switch --detach v1.1_027
foo@bar:~$ rougail -m firefox/ -u yaml -ff config/03/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/03/config.yaml" (⏳ No proxy) ┗━━ 📂 Manual proxy configuration ┗━━ 📂 HTTP Proxy ┣━━ 📓 HTTP address: example.net ◀ loaded from the YAML file "config/03/config.yaml" ┗━━ 📓 HTTP Port: 8080
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_027
foo@bar:~$ rougail -m firefox/ -u yaml -ff config/04/config.yaml
╭────────────── Caption ───────────────╮ │ Variable Modified value │ │ (⏳ Original default value) │ ╰──────────────────────────────────────╯ Variables: ┣━━ 📓 Configure Proxy Access to the Internet: Manual proxy configuration ◀ loaded from the YAML file "config/04/config.yaml" (⏳ No proxy) ┗━━ 📂 Manual proxy configuration ┗━━ 📂 HTTP Proxy ┣━━ 📓 HTTP address: example.net ◀ loaded from the YAML file "config/04/config.yaml" ┗━━ 📓 HTTP Port: 3128 ◀ loaded from the YAML file "config/04/config.yaml" (⏳ 8080)
Output in read write mode
foo@bar:~$ git switch --detach v1.1_027
foo@bar:~$ rougail -m firefox/ -u yaml -ff config/04/config.yaml --cli.read_write
╭────────────── Caption ───────────────╮ │ Variable Modified value │ │ (⏳ Original default value) │ ╰──────────────────────────────────────╯ Variables: ┣━━ 📓 Configure Proxy Access to the Internet: Manual proxy configuration ◀ loaded from the YAML file "config/04/config.yaml" (⏳ No proxy) ┗━━ 📂 Manual proxy configuration ┗━━ 📂 HTTP Proxy ┣━━ 📓 HTTP address: example.net ◀ loaded from the YAML file "config/04/config.yaml" ┗━━ 📓 HTTP Port: 3128 ◀ loaded from the YAML file "config/04/config.yaml" (⏳ 8080)
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_027
foo@bar:~$ rougail -m firefox/ -u yaml -ff config/05/config.yaml
🔔 WARNINGS ┣━━ variable or family "manual.use_for_https" does not exist, it will be ignored when loading from the YAML file "config/05/config.yaml" ┗━━ variable or family "manual.https_proxy" does not exist, it will be ignored when loading from the YAML file "config/05/config.yaml" ╭────────────── Caption ───────────────╮ │ Variable 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)
Output in read write mode
foo@bar:~$ git switch --detach v1.1_027
foo@bar:~$ rougail -m firefox/ -u yaml -ff config/05/config.yaml --cli.read_write
🔔 WARNINGS ┣━━ variable or family "manual.use_for_https" does not exist, it will be ignored when loading from the YAML file "config/05/config.yaml" ┗━━ variable or family "manual.https_proxy" does not exist, it will be ignored when loading from the YAML file "config/05/config.yaml" ╭────────────── Caption ───────────────╮ │ Variable 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)