Skip to content
This repository has been archived by the owner on Mar 27, 2023. It is now read-only.

Commit

Permalink
Improve example
Browse files Browse the repository at this point in the history
  • Loading branch information
jbutcher5 authored Feb 24, 2022
1 parent 801c717 commit 39cf058
Showing 1 changed file with 18 additions and 6 deletions.
24 changes: 18 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,12 +18,24 @@ Input and output variables used by read-yaml
## Example usage

``` yaml
name: Read YAML Data
uses: KJ002/[email protected]
id: yaml-data
with:
file: './action.yaml'
key-path: '["runs", "using"]' # Access the runs key then the using key and retuns the value.
on: [ push, pull_request ]

jobs:
test-yaml-reader:
runs-on: ubuntu-latest
name: Test read-yaml
steps:
- uses: actions/checkout@v1

- name: Run read-yaml action
id: yaml-data
uses: KJ002/read-yaml@main # You may wish to replace main with a version tag such as '1.5' etc.
with:
file: './action.yml' # File to read from
key-path: '["runs", "using"]' # Access the runs key then the using key and retuns the value.

- name: Display read-yaml output
run: echo "${{ steps.yaml-data.outputs.data }}"
```
## Contributing and Local Development
Expand Down

0 comments on commit 39cf058

Please sign in to comment.