Skip to content

Commit

Permalink
build(helm): generate README.md.gotmpl in CI
Browse files Browse the repository at this point in the history
  • Loading branch information
paullaffitte committed Aug 13, 2024
1 parent b41f866 commit a9483b5
Show file tree
Hide file tree
Showing 4 changed files with 28 additions and 363 deletions.
25 changes: 24 additions & 1 deletion .github/workflows/pr-packaging.yml
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,30 @@ jobs:
run: |
set -euo pipefail
ct lint --chart-dirs deploy/charts --target-branch ${{ github.base_ref }} \
--validate-maintainers=false --check-version-increment=false
--validate-maintainers=false --check-version-increment=false
- name: Check README generation exits with 0
shell: python
env:
WORKSPACE: ${{ github.workspace }}
PYTHONPATH: ${{ github.workspace }}/.github
HELM_DOCS_PATH: ${{ github.workspace }}/bin/helm-docs
run: |
from lib import *
import os, yaml, shutil
chart_path = os.path.join(os.environ['WORKSPACE'], 'helm', 'kube-image-keeper')
os.chdir(chart_path)
header('generate chart readme')
run('pwd')
run('ls ../../')
run('make --help')
run('make -C ../../ helm-docs')
run(os.environ['HELM_DOCS_PATH'], '--dry-run')
run(os.environ['HELM_DOCS_PATH'])
run('cat README.md')
# FIXME
#- name: Create KinD cluster
Expand Down
1 change: 1 addition & 0 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -814,6 +814,7 @@ jobs:
header('generate chart readme')
run('make -C ../../ helm-docs')
run(os.environ['HELM_DOCS_PATH'], '--dry-run')
run(os.environ['HELM_DOCS_PATH'])
Expand Down
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -28,3 +28,6 @@ zz_generated.*

# helm dependencies
helm/**/charts/*.tgz

# generated helm README template
helm/**/README.md.gotmpl
Loading

0 comments on commit a9483b5

Please sign in to comment.