mirror of
https://github.com/bitnami/charts.git
synced 2026-02-27 06:48:01 +08:00
Use readme-generator npm package in generate-readme workflow (#13074)
Signed-off-by: Fran Mulero <fmulero@vmware.com>
This commit is contained in:
25
.github/workflows/generate-chart-readme.yml
vendored
25
.github/workflows/generate-chart-readme.yml
vendored
@@ -13,27 +13,8 @@ jobs:
|
||||
runs-on: ubuntu-latest
|
||||
|
||||
steps:
|
||||
- name: Checkout bitnami-labs/readme-generator-for-helm
|
||||
uses: actions/checkout@v3
|
||||
with:
|
||||
repository: 'bitnami-labs/readme-generator-for-helm'
|
||||
ref: '1af12881436b1f58f0643d733fd5196b4a11caa8'
|
||||
path: readme-generator-for-helm
|
||||
|
||||
- name: Cache node modules
|
||||
uses: actions/cache@v3
|
||||
env:
|
||||
cache-name: cache-node-modules
|
||||
with:
|
||||
# npm cache files are stored in `~/.npm` on Linux/macOS
|
||||
path: ~/.npm
|
||||
key: ${{ runner.os }}-build-${{ env.cache-name }}-${{ hashFiles('readme-generator-for-helm/package-lock.json') }}
|
||||
restore-keys: |
|
||||
${{ runner.os }}-build-${{ env.cache-name }}-
|
||||
|
||||
- name: Install readme-generator-for-helm dependencies
|
||||
run: cd readme-generator-for-helm && npm install
|
||||
|
||||
- name: Install readme-generator-for-helm
|
||||
run: npm install -g @bitnami/readme-generator-for-helm@2.4.2
|
||||
- name: Checkout bitnami/charts
|
||||
uses: actions/checkout@v3
|
||||
with:
|
||||
@@ -52,7 +33,7 @@ jobs:
|
||||
charts_dirs_changed="$(echo "$files_changed" | xargs dirname | grep -o "bitnami/[^/]*" | sort | uniq || true)"
|
||||
for chart in ${charts_dirs_changed}; do
|
||||
echo "Updating README.md for ${chart}"
|
||||
readme-generator-for-helm/bin/index.js --values "charts/${chart}/values.yaml" --readme "charts/${chart}/README.md" --schema "/tmp/schema.json"
|
||||
readme-generator --values "charts/${chart}/values.yaml" --readme "charts/${chart}/README.md" --schema "/tmp/schema.json"
|
||||
done
|
||||
- name: Push changes
|
||||
run: |
|
||||
|
||||
Reference in New Issue
Block a user