Skip to content

Commit

Permalink
docs: update readme with env details
Browse files Browse the repository at this point in the history
  • Loading branch information
mshick committed Apr 9, 2020
1 parent 4c5c52c commit 50615af
Showing 1 changed file with 21 additions and 3 deletions.
24 changes: 21 additions & 3 deletions README.md
Expand Up @@ -12,18 +12,36 @@
FOO_VALUE: cat good
BAR_VALUE: dog food
with:
in-file: fixtures/example.yaml.in
out-file: fixtures/example.yaml
env-file: __tests__/fixtures/example.env
in-file: __tests__/fixtures/example.yaml.in
out-file: __tests__/runner/example.yaml
```

**example.yaml.in**
input: **example.env**

```
ROGER=RABBIT
```

input: **example.yaml.in**

```yaml
example:
foo: ${FOO_VALUE}
bar: ${BAR_VALUE}
roger: ${ROGER}
```

output: **example.yaml**

```yaml
example:
foo: cat good
bar: dog food
roger: RABBIT
```

## Features

- Fast, runs in the GitHub Actions node.js runtime; no Docker pull needed.
- Provide an env file and have it loaded into your substitution environment

0 comments on commit 50615af

Please sign in to comment.