README.md

YAML Outputs Action 🚀

This GitHub Action reads a YAML file and flattens it recursively into a set of output parameters.

Inputs 📝

file-path

Required The path of the YAML file to read.

separator

Optional The separator used to concatenate child properties. For example, if the YAML file contains:

root:
  parent:
    child: true

then setting separator to '' would result in the output parameter rootparent__child being set to true.

Default: '__'

node

Optional The node to start flattening from. For example, if the YAML file contains:

root:
  parent:
    child: true

and node is set to root.parent, then the output parameter child will be set to true.

Default: all the nodes in the file will be used.

export-env-variables

Optional It controls whether outputs are exported as environment variables or not. Default: true.

fail-on-file-not-found

Optional It controls whether the action should fail if the file-path is found or not. Default: true.

Outputs 📜

This action generates one output parameter for each key in the flattened YAML file. The name of each output parameter is the concatenation of the flattened key and the separator.

Usage 📚

Given a YAML file .github/test-file.yaml with the following properties:

root:
  parent:
    child_1: 'my_string_111'
    child_2: 112

we can use the action to get the properties as flattened outputs:

name: 'read-yaml'
on:
  push:
jobs:
  test:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - uses: actions-tools/yaml-outputs@v2
        id: yaml
        with:
          file-path: '.github/test-file.yaml'
      - run: |
          echo "${{ steps.yaml.outputs.root__parent__child_1 }}"
          echo "${{ steps.yaml.outputs.root__parent__child_2 }}"
          echo "${{ env.root__parent__child_1 }}"
          echo "${{ env.root__parent__child_2 }}"