action-yaml-update

action-yaml-update

GitHub Action to automate updating YAML files with full format and comment preservation. Supports Helm values, Kustomize configs, and any YAML file.

Uses ruamel.yaml for round-trip YAML processing — comments, formatting, and quote styles are preserved.

usage

key mode (explicit paths)

- name: update yaml values
  uses: DND-IT/action-yaml-update@v1
  with:
    files: |
      deploy/values.yaml
    keys: |
      webapp.image.tag
      webapp.replicas
    values: |
      v2.0.0
      5

image mode (search by image name)

- name: update image tag
  uses: DND-IT/action-yaml-update@v1
  with:
    files: |
      deploy/values.yaml
      deploy/kustomization.yaml
    mode: image
    image_name: webapp
    image_tag: v2.0.0

dry run

- name: preview changes
  id: preview
  uses: DND-IT/action-yaml-update@v1
  with:
    files: deploy/values.yaml
    keys: app.version
    values: v2.0.0
    dry_run: 'true'

- name: show diff
  run: echo "${{ steps.preview.outputs.diff }}"

full example with PR

name: update deployment
on:
  workflow_dispatch:
    inputs:
      tag:
        description: 'Image tag to deploy'
        required: true

jobs:
  update:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - name: update image tag
        id: update
        uses: DND-IT/action-yaml-update@v1
        with:
          files: deploy/values.yaml
          mode: image
          image_name: webapp
          image_tag: ${{ github.event.inputs.tag }}
          create_pr: 'true'
          pr_title: 'chore: deploy webapp ${{ github.event.inputs.tag }}'
          pr_labels: deployment, automated
          auto_merge: 'true'
          merge_method: SQUASH

      - name: output PR url
        if: steps.update.outputs.pr_url
        run: echo "PR created: ${{ steps.update.outputs.pr_url }}"

inputs

outputs

key path syntax

Dot-notation paths to traverse nested YAML structures:

• app.version — nested key
• webapp.image.tag — deeply nested
• images.0.newTag — list index access

image mode

In image mode, the action recursively searches the YAML tree for:

• Helm-style: repository/tag pairs where repository ends with the image name
• Kustomize-style: name/newTag pairs where name ends with the image name

development

# install dependencies
uv sync --dev

# run tests
uv run pytest --cov --cov-report=term-missing

# lint
uv run ruff check src/ tests/
uv run ruff format --check src/ tests/

# build docker image locally
docker build -t action-yaml-update .

license

MIT

support

Maintained by group:default/dai