Skip to content

Commit 3fadf90

Browse files
committed
- Add settings environment suffix
1 parent 6640884 commit 3fadf90

File tree

1 file changed

+17
-1
lines changed

1 file changed

+17
-1
lines changed

src/usage/settings.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,20 @@ Bashly will look for the settings file in one of these paths:
2525
- A file named `bashly-settings.yml` in the working directory.
2626
- A file named `settings.yml` in the working directory.
2727

28+
### Environment Overrides
29+
30+
All options in the settings file (except `env`) may be specified with an
31+
environment suffix in order to override its value for a given environment
32+
(`production` or `development`).
33+
34+
For example, when defining `formatter_production: shfmt --minify`, then
35+
this will be the formatter used when generating the script with
36+
`bashly generate --env production`.
37+
38+
Since these values take precedence over the standard values, you can define
39+
both (i.e. `formatter: shfmt` and `formatter_production: shfmt --minify`).
40+
41+
2842
!!!success YAML Tips
2943
- The words `yes` and `no` are equivalent to `true` and `false`
3044
- To specify a `null` value, use `~`
@@ -36,13 +50,15 @@ Bashly will look for the settings file in one of these paths:
3650

3751
All settings are optional (with their default values provided below), and
3852
can also be set with an environment variable with the same name, capitalized
39-
and prefixed by `BASHLY_` - for example: `BASHLY_SOURCE_DIR`
53+
and prefixed by `BASHLY_` - for example: `BASHLY_SOURCE_DIR` environment
54+
variable is the same as specifying `source_dir` in the settings file.
4055

4156
When setting environment variables, you can use:
4257

4358
- `0`, `false` or `no` to represent false
4459
- `1`, `true` or `yes` to represent true
4560

61+
4662
## Path Options
4763

4864
### `source_dir`

0 commit comments

Comments
 (0)