Skip to content

action-yamler

Actions
A GitHub Action for easily manipulating yaml files
v1.1.1
Latest
Star (0)

action-yamler

This GitHub Action helps to manipulate yaml and flat-files files easily.

Important: when using a flat-file you MUST set flat: true and the file MUST contain ONLY a version.

For example: ./workspace/VERSION

0.0.1

Examples

This example demonstrates using this action to update the version in a pubspec.yaml by appending -dev.NNNNN.

- name: ✍🏼 version
  uses: endaft/action-yamler@v1.0.5
  with:
    file: ./pubspec.yaml
    path: version
    set: -dev.${{ github.run_number }}
    get: true
    append: true

This example demonstrates using this action to update the value in a flat-file by appending -dev.NNNNN.

- name: ✍🏼 version
  uses: endaft/action-yamler@v1.0.5
  with:
    file: ./version
    flat: true
    set: -dev.${{ github.run_number }}
    get: true
    append: true

Inputs

name required description default
file true The path to a yaml file
path if flat is false The dotted yaml path to edit. Ex: object.item.name or list.0.name.
get false Whether or not to get the value into the output. true
set false The value to set at the path.
append false Whether or not the set value is appended or put at the path. false
flat false Whether or not the file references a flat-file. false

Outputs

name description
value_old If the get attribute is true, this holds the value found at the path before changing it or an empty string if the path doesn't exist.
value_new If the get attribute is true, this holds the value set at the path after changing it.

action-yamler is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.

About

A GitHub Action for easily manipulating yaml files
v1.1.1
Latest

action-yamler is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.