WARNING: THIS SITE IS A MIRROR OF GITHUB.COM / IT CANNOT LOGIN OR REGISTER ACCOUNTS / THE CONTENTS ARE PROVIDED AS-IS / THIS SITE ASSUMES NO RESPONSIBILITY FOR ANY DISPLAYED CONTENT OR LINKS / IF YOU FOUND SOMETHING MAY NOT GOOD FOR EVERYONE, CONTACT ADMIN AT ilovescratch@foxmail.com
Skip to content

Feature: Generate Helm Docs on Release #143

@PcInfamy

Description

@PcInfamy

Since the version number changes before release, it makes sense to automatically regenerate the helm docs in the release workflow. Should be relatively easy to do like this (might need a few tweaks):

# After "Add repositories" and before "Run chart-releaser"
- name: Generate chart docs (helm-docs)
  uses: norwoodj/[email protected]
  with:
    chart-search-root: charts
    template-files: README.md.gotmpl
    output-file: README.md

- name: Commit updated docs (only if changed and not by bot)
  if: ${{ github.actor != 'github-actions[bot]' }}
  run: |
    if ! git diff --quiet; then
      git add -A
      git commit -m "chore(docs): regenerate chart README and version metadata [skip ci]"
      git push origin main
    fi

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions