Skip to content

Action that installs Helm Docs, a tool for automatically generating markdown documentation for Helm charts

Notifications You must be signed in to change notification settings

gabe565/setup-helm-docs-action

Use this GitHub action with your project
Add this Action to an existing workflow or create a new one
View on Marketplace

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

19 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Setup Helm Docs Action

This action installs norwoodj/helm-docs, a tool for automatically generating markdown documentation for Helm charts.

Usage

Inputs

Name Description Required Default
version The Helm Docs version to install false latest
repo The Helm Docs repo to use false norwoodj/helm-docs
token GitHub token false ${{ github.token }}

Outputs

Name Description
version The Helm Docs version that was installed

Example Workflow

name: Update Chart Metadata

on: push

jobs:
  update-chart-metadata:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - uses: gabe565/setup-helm-docs-action@v1
      - run: helm-docs

About

Action that installs Helm Docs, a tool for automatically generating markdown documentation for Helm charts

Topics

Resources

Stars

Watchers

Forks