Skip to content

fix(wik-webservice): add option securityDefaults #31

fix(wik-webservice): add option securityDefaults

fix(wik-webservice): add option securityDefaults #31

Workflow file for this run

name: Generate Documentation
on:
pull_request:
paths:
- 'charts/**/values.yaml'
- 'charts/**/Chart.yaml'
- 'charts/**/README.md.gotmpl'
push:
branches:
- main
paths:
- 'charts/**/values.yaml'
- 'charts/**/Chart.yaml'
- 'charts/**/README.md.gotmpl'
jobs:
docs:
runs-on: ubuntu-latest
permissions:
contents: write
pull-requests: write
steps:
- name: Checkout
uses: actions/checkout@v4
with:
ref: ${{ github.head_ref }}
fetch-depth: 0
- name: Install helm-docs
run: |
wget https://github.com/norwoodj/helm-docs/releases/download/v1.13.1/helm-docs_1.13.1_Linux_x86_64.tar.gz
tar -xzf helm-docs_1.13.1_Linux_x86_64.tar.gz
sudo mv helm-docs /usr/local/bin/
- name: Run helm-docs
run: helm-docs --chart-search-root=charts
- name: Check for changes
id: changes
run: |
if [[ -n "$(git status --porcelain)" ]]; then
echo "changed=true" >> "$GITHUB_OUTPUT"
fi
- name: Commit changes (push to main)
if: github.event_name == 'push' && steps.changes.outputs.changed == 'true'
run: |
git config user.name "github-actions[bot]"
git config user.email "github-actions[bot]@users.noreply.github.com"
git add charts/*/README.md
git commit -m "docs: auto-generate chart documentation"
git push
- name: Comment on PR
if: github.event_name == 'pull_request' && steps.changes.outputs.changed == 'true'
uses: actions/github-script@v8
with:
script: |
github.rest.issues.createComment({
owner: context.repo.owner,
repo: context.repo.repo,
issue_number: context.issue.number,
body: '⚠️ **Documentation out of date**\n\nPlease run `helm-docs` locally or documentation will be auto-updated on merge.'
})