nsxsoft / action-read-yaml

Custom github action used to read yaml files, supporting multiple keys and variable replacements

Read YAML Github action

This action reads a .yaml file, and sets one output for every key it has. These outputs can be used in later steps, which allows a yaml file to function as a configuration file within a Github workflow.

Furthermore it supports variables interpolation, using the $(var) syntax. This allows for complex dependencies and relationship between keys, enabling great flexibility when creating the yaml file.

Finally, it supports hierarchy of nested values, representing the output through dot notation.

For more information, check the example below.

Example usage

Two examples are provided in the examples folder.

Basic config

The config file contains the following keys:

namespace: namespace_example
location: location_example
environment: dev

resource_group_name: $(namespace)-$(location)-$(environment) # this will be replaced with the variables above

Note that the key resource_group_name uses variable interpolation. The key value will resolve to: namespace_example-location_example-dev.

The action reads the yaml file as following:

name: helpers-read-yaml

on:
  push:
  workflow_dispatch:

jobs:
  read-yaml:
    runs-on: ubuntu-latest
    steps:
      - name: checkout
        uses: actions/checkout@v3

      - name: read-yaml-file
        uses: pietrobolcato/[email protected]
        id: read_action_js
        with:
          config: ${{ github.workspace }}/examples/config_example.yaml

      - name: use-yaml-file
        run: |
          echo namespace: ${{ steps.read_action_js.outputs['namespace'] }}
          echo location: ${{ steps.read_action_js.outputs['location'] }}
          echo environment: ${{ steps.read_action_js.outputs['environment'] }}
          echo resource_group_name: ${{ steps.read_action_js.outputs['resource_group_name'] }}

And outputs:

namespace: namespace_example
location: location_example
environment: dev
resource_group_name: namespace_example-location_example-dev

Nested config

The config file contains the following keys:

name: example
environment:
  name: example
  permissions:
    - name: example
      permission: read
    - name: example2
      permission: write
deployment:
  code:
    source:
      libs: path/to/libs
      entry: path/to/entry

Note that this is contained nested values. The action reads the yaml file in the same way as the example above, and outputs:

name: example
environment.name: example
environment.permissions.0.name: example
environment.permissions.0.permission: read
environment.permissions.1.name: example2
environment.permissions.1.permission: write
deployment.code.source.libs: path/to/libs
deployment.code.source.entry: path/to/entry