jbutcher5/read-yaml

A GitHub Action to read yaml files.

Read YAML

This action reads yaml data from a file and outputs the result.

IO

Input and output variables used by read-yaml

Inputs

• file Required yaml file to read from.

• key-path Required Path of keys to the value as a JSON list.

Outputs

• data Data read from YAML file.

Example usage

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: jbutcher5/read-yaml@main      # You may wish to replace main with a version tag such as '1.6' 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

Check the CONTRIBUTING guidelines for information on how to contribute to read-yaml

read-yaml's Issues

How to read nested key?

Hi!

Can you please help to specify how exactly I can read the nested value in my yaml file?

Thanks!

yaml example:

environment:
  first: "value first"
  second: 'value second'

Bad indentation on code example in the README.md

Specifically on Line 33, corrected:

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.6' 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 }}"

Invalid Package.json -- comma is misplaced on line number 31 instead of 32

#99
Fixed Raised here

Accessing outputs from a step

Where are the output's getting stored.

Issue with values starting with zero

Hello there,

we are using this action to read configuration yaml for deployments. If we have a value for key that starts with 0 (zero) it is being removed in the action output. Is there anything that fix that? I am not js guy therefore cannot provide a PR for fix. Thanks in advance.

example:
accountid: '0123456789'

Github actions will be deprecating the use of ::set-output and moving to Environment Variables

When the action runs we get this warning:

Warning: The `set-output` command is deprecated and will be disabled soon. Please upgrade to using Environment Files. For more information see: https://github.blog/changelog/2022-10-11-github-actions-deprecating-save-state-and-set-output-commands/

Other than that that's it. Thanks

Accessing multiple keys

Hi,
is it possible to access multiple keys in the same step or do I need to create a new step for every key?
Thanks!

Accessing nested variables

Hi there,
This is my yaml file

if I pass the value Dyn.Module is not able to retrieve the value.
Any suggestions?

No Example??

Can you please provide some example of Yaml data and how to consume it? What is Key-Path and what are "runs" and "using"? Very disappointing documentation.