ci: fix linting of created PR

grafana · Oct 16, 2024 · ed80bed · ed80bed
1 parent 1cd29f8
commit ed80bed
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 2 deletions.
diff --git a/.github/workflows/helm-weekly-release-pr.yaml b/.github/workflows/helm-weekly-release-pr.yaml
@@ -47,7 +47,7 @@ jobs:
         uses: peter-evans/create-pull-request@v5
         with:
           token: ${{ steps.get_github_app_token.outputs.token }}
-          title: Release loki Helm chart ${{ steps.update-k.outputs.new_chart_version }}
+          title: "chore: release loki Helm chart ${{ steps.update-k.outputs.new_chart_version }}"
           body: Automated PR created by [helm-weekly-release-pr.yaml](https://github.com/grafana/loki/blob/main/.github/workflows/helm-weekly-release-pr.yaml)
           commit-message: Update loki chart to ${{ steps.update-k.outputs.new_chart_version }}
           branch: helm-chart-weekly-${{ steps.update-k.outputs.new_chart_version }}
@@ -62,7 +62,7 @@ jobs:
         uses: peter-evans/create-pull-request@v5
         with:
           token: ${{ steps.get_github_app_token.outputs.token }}
-          title: Release loki Helm chart ${{ steps.update.outputs.new_chart_version }}
+          title: "chore: release loki Helm chart ${{ steps.update.outputs.new_chart_version }}"
           body: Automated PR created by [helm-weekly-release-pr.yaml](https://github.com/grafana/loki/blob/main/.github/workflows/helm-weekly-release-pr.yaml)
           commit-message: Update loki chart to ${{ steps.update.outputs.new_chart_version }}
           branch: helm-chart-weekly-${{ steps.update.outputs.new_chart_version }}

diff --git a/docs/Makefile b/docs/Makefile
@@ -17,7 +17,12 @@ ifeq ($(BUILD_IN_CONTAINER),true)
 		-c /helm-docs/production/helm/ \
 		-t reference.md.gotmpl \
 		-o reference.md
+	$(PODMAN) run --rm --volume "$(realpath ..):/helm-docs" -u "$$(id -u)" "docker.io/jnorwood/helm-docs:v1.11.0" \
+		-c /helm-docs/production/helm/ \
+		-t README.md.gotmpl \
+		-o README.md
 else
 	helm-docs -c ../production/helm/ -t reference.md.gotmpl -o reference.md
+	helm-docs -c ../production/helm/ -t README.md.gotmpl -o README.md
 endif
 	mv "$(basename $<)" "$@"