mirror of
https://github.com/k8s-at-home/charts.git
synced 2025-01-24 16:09:08 +00:00
92 lines
2.7 KiB
YAML
92 lines
2.7 KiB
YAML
name: "Charts: Auto-generate docs"
|
|
|
|
on:
|
|
workflow_dispatch:
|
|
pull_request:
|
|
paths:
|
|
- 'charts/**/Chart.yaml'
|
|
- 'charts/**/values.yaml'
|
|
- 'charts/**/*.md.gotmpl'
|
|
- 'charts/**/README.md'
|
|
|
|
concurrency:
|
|
group: ${{ github.head_ref }}-generate-docs
|
|
cancel-in-progress: true
|
|
|
|
jobs:
|
|
generate-readme:
|
|
if: "!contains(github.event.head_commit.message, '[ci-skip]') && github.actor != 'k8s-at-home[bot]'"
|
|
name: Auto-generate chart README
|
|
runs-on: ubuntu-20.04
|
|
steps:
|
|
- name: Get k8s-at-home token
|
|
id: get-app-token
|
|
uses: getsentry/action-github-app-token@v1
|
|
with:
|
|
app_id: ${{ secrets.K8S_AT_HOME_APP_ID }}
|
|
private_key: ${{ secrets.K8S_AT_HOME_APP_PRIVATE_KEY }}
|
|
|
|
- name: Checkout
|
|
uses: actions/checkout@v2
|
|
with:
|
|
token: ${{ steps.get-app-token.outputs.token }}
|
|
ref: ${{ github.ref }}
|
|
fetch-depth: 0
|
|
|
|
- uses: dorny/paths-filter@v2
|
|
id: filter
|
|
with:
|
|
list-files: shell
|
|
filters: |
|
|
addedOrModified:
|
|
- added|modified: 'charts/**'
|
|
|
|
- name: Install Helm
|
|
if: steps.filter.outputs.addedOrModified == 'true'
|
|
uses: azure/setup-helm@v1
|
|
with:
|
|
version: v3.5.3
|
|
|
|
- uses: actions/setup-python@v2
|
|
if: steps.filter.outputs.addedOrModified == 'true'
|
|
with:
|
|
python-version: 3.7
|
|
|
|
- name: Install helm-docs
|
|
if: steps.filter.outputs.addedOrModified == 'true'
|
|
run: |
|
|
wget -O /tmp/helm-docs.deb https://github.com/norwoodj/helm-docs/releases/download/v1.5.0/helm-docs_1.5.0_linux_amd64.deb
|
|
sudo dpkg -i /tmp/helm-docs.deb
|
|
|
|
- name: Run against changed charts
|
|
if: steps.filter.outputs.addedOrModified == 'true'
|
|
run: |
|
|
CHARTS=()
|
|
PATHS=(${{ steps.filter.outputs.addedOrModified_files }})
|
|
# Get only the chart paths
|
|
for i in "${PATHS[@]}"
|
|
do
|
|
IFS='/' read -r -a path_parts <<< "$i"
|
|
CHARTS+=("${path_parts[1]}/${path_parts[2]}")
|
|
done
|
|
|
|
# Remove duplicates
|
|
CHARTS=( `for i in ${CHARTS[@]}; do echo $i; done | sort -u` )
|
|
|
|
for i in "${CHARTS[@]}"
|
|
do
|
|
echo "Rendering README for chart ${i}"
|
|
IFS='/' read -r -a chart_parts <<< "$i"
|
|
./hack/gen-helm-docs.sh "${chart_parts[0]}" "${chart_parts[1]}"
|
|
echo ""
|
|
done
|
|
|
|
- name: Update Pull Request
|
|
uses: stefanzweifel/git-auto-commit-action@v4
|
|
with:
|
|
commit_message: Auto-generate chart README
|
|
commit_user_name: k8s-at-home[bot]
|
|
commit_user_email: <k8s-at-home[bot]@users.noreply.github.com>
|
|
commit_author: k8s-at-home[bot] <k8s-at-home[bot]@users.noreply.github.com>
|
|
file_pattern: charts/**/
|