Skip to content

Commit

Permalink
chore: Minor documentation updates (#276)
Browse files Browse the repository at this point in the history
* Explicitly state that experimental mode is not covered by semver
* Document literal variable syntax in services.yml
  • Loading branch information
cszatmary authored Jun 8, 2020
1 parent fab0d77 commit 3abfe6e
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 0 deletions.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,7 @@ To toggle debug mode set the `debug` property to `true` or `false`. Debug mode w
### Toggling experimental mode
To to enable experimental mode set the `experimental` field to `true`. Experimental mode will give you access to any new features that are still in the process of being tested.
Please be aware that you may encounter bugs with these features as they have not yet been deemed ready for general use.
Also, experimental mode is not covered by semver guarantees, so there could be breaking changes at any time.

If you would like to help use test new features, we would appreciate it if you could enable experimental mode and report any issues you encounter.

Expand Down
14 changes: 14 additions & 0 deletions docs/registries.md
Original file line number Diff line number Diff line change
Expand Up @@ -185,6 +185,20 @@ dependencies:
- ${@postgres}
```

##### Literal Variables

If you required the literal variable syntax and don't want `tb` to expand it, prefix the variable name with `@env:`. `tb` will strip this prefix and leave the variable expansion syntax.

Ex:
```yaml
envPath: ${@env:HOME}/tmp
```

`tb` will turn this into:
```yaml
envPath: ${HOME}/tmp
```

## Configuring Playlists

A playlist is a collection of services that can be run with `tb up`.
Expand Down

0 comments on commit 3abfe6e

Please sign in to comment.