Skip to content

fix: clone CLI chart to /tmp to avoid submodule and copy helm docs correctly #62

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dangrondahl merged 1 commit into from
Mar 10, 2026
Merged

fix: clone CLI chart to /tmp to avoid submodule and copy helm docs correctly #62

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 7 additions & 10 deletions .github/workflows/update-cli-docs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,14 +57,6 @@ jobs:
- name: Update CLI navigation in docs.json
run: python scripts/update-cli-nav.py --docs-dir client_reference/ --config docs.json

- name: Checkout CLI repo at tag (sparse)
uses: actions/checkout@v4
with:
repository: kosli-dev/cli
ref: refs/tags/${{ steps.tag.outputs.cli_tag }}
sparse-checkout: charts/k8s-reporter
path: cli-repo

- name: Install helm-docs
run: |
curl -sL https://github.com/norwoodj/helm-docs/releases/download/v1.14.2/helm-docs_1.14.2_Linux_x86_64.deb --output helm-docs.deb
Expand All @@ -73,8 +65,13 @@ jobs:

- name: Generate helm docs
run: |
cd $GITHUB_WORKSPACE/cli-repo/charts/k8s-reporter
helm-docs --template-files README.md.gotmpl,_templates.gotmpl --output-file $GITHUB_WORKSPACE/helm/k8s_reporter.md
git clone --sparse --filter=blob:none --depth=1 \
--branch ${{ steps.tag.outputs.cli_tag }} \
https://github.com/kosli-dev/cli.git /tmp/cli-repo
cd /tmp/cli-repo && git sparse-checkout set charts/k8s-reporter
cd /tmp/cli-repo/charts/k8s-reporter
helm-docs --template-files README.md.gotmpl,_templates.gotmpl
cp /tmp/cli-repo/charts/k8s-reporter/README.md $GITHUB_WORKSPACE/helm/k8s_reporter.md

- name: Create Pull Request
uses: peter-evans/create-pull-request@v8
Expand Down
Loading