feat(helm): add action to generate chart documentation

Signed-off-by: Emilien Escalle <emilien.escalle@escemi.com>

Author: neilime

.github/workflows/__pull-request-ci.yml

@@ -8,10 +8,10 @@ on: # yamllint disable-line rule:truthy
 
 permissions:
   actions: read
-  contents: read
+  contents: write
   issues: read
   packages: write
-  pull-requests: read
+  pull-requests: write
   security-events: write
   statuses: write
   # FIXME: This is a workaround for having workflow actions. See https://github.com/orgs/community/discussions/38659

.github/workflows/__shared-ci.yml

@@ -6,10 +6,10 @@ on: # yamllint disable-line rule:truthy
 
 permissions:
   actions: read
-  contents: read
+  contents: write
   issues: read
   packages: write
-  pull-requests: read
+  pull-requests: write
   security-events: write
   statuses: write
   # yamllint disable-line rule:line-length
@@ -42,6 +42,11 @@ jobs:
     needs: linter
     uses: ./.github/workflows/__test-action-get-image-name.yml
 
+  test-action-helm-generate-docs:
+    needs: linter
+    uses: ./.github/workflows/__test-action-helm-generate-docs.yml
+    secrets: inherit
+
   test-action-helm-parse-chart-uri:
     needs: linter
     uses: ./.github/workflows/__test-action-helm-parse-chart-uri.yml

.github/workflows/__test-action-helm-generate-docs.yml

@@ -0,0 +1,23 @@
+---
+name: Test for "helm/generate-docs" action
+run-name: Test for "helm/generate-docs" action
+
+on: # yamllint disable-line rule:truthy
+  workflow_call:
+
+permissions:
+  contents: write
+  pull-requests: write
+
+jobs:
+  tests:
+    name: Test for "helm/generate-docs" action
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+
+      - id: generate-docs
+        uses: ./actions/helm/generate-docs
+        with:
+          working-directory: ./tests/charts
+          github-token: ${{ secrets.GITHUB_TOKEN }}

README.md

@@ -25,6 +25,8 @@ Opinionated GitHub Actions and workflows for continuous integration in container
 
 ### Helm
 
+#### - [Generate chart documentation](actions/helm/generate-docs/README.md)
+
 #### - [Parse chart URI](actions/helm/parse-chart-uri/README.md)
 
 #### - [Release chart](actions/helm/release-chart/README.md)

actions/helm/generate-docs/README.md

@@ -0,0 +1,24 @@
+<!-- start title -->
+<!-- end title -->
+<!--
+// jscpd:ignore-start
+-->
+<!-- markdownlint-disable MD013 -->
+<!-- start badges -->
+<!-- end badges -->
+<!-- markdownlint-enable MD013 -->
+<!--
+// jscpd:ignore-end
+-->
+<!-- start description -->
+<!-- end description -->
+<!-- start contents -->
+<!-- end contents -->
+<!-- start usage -->
+<!-- end usage -->
+<!-- start inputs -->
+<!-- end inputs -->
+<!-- start outputs -->
+<!-- end outputs -->
+<!-- start [.github/ghadocs/examples/] -->
+<!-- end [.github/ghadocs/examples/] -->

actions/helm/generate-docs/action.yml

@@ -0,0 +1,48 @@
+---
+name: "Helm - Generate Chart Documentation"
+description: |
+  Action to generate documentation for a Helm chart.
+  It will generate the documentation in the `docs/` directory of the chart.
+  Mainly using [losisin/helm-docs-github-action](https://github.com/losisin/helm-docs-github-action).
+author: Hoverkraft
+branding:
+  icon: book-open
+  color: blue
+
+inputs:
+  working-directory:
+    description: "Working directory"
+    required: false
+    default: "${{ github.workspace }}"
+  github-token:
+    description: |
+      GitHub Token to create and merge pull request.
+      Permissions:
+        - contents: write
+        - pull-requests: write
+    default: ${{ github.token }}
+
+runs:
+  using: "composite"
+  steps:
+    - shell: bash
+      id: prepare-variables
+      run: |
+        echo "working-directory-name=$(basename "${{ inputs.working-directory }}")" >> "$GITHUB_OUTPUT"
+
+    - uses: hoverkraft-tech/ci-github-common/actions/checkout@9a3d71ca9f68bc1061db8ea1442084ac31a0f8bf # 0.23.0
+
+    - uses: losisin/helm-docs-github-action@8dc2304e986afbbb0b7db0a9980b6bf68c1307cf # v1.5.2
+      with:
+        chart-search-root: ${{ inputs.working-directory }}
+
+    - uses: hoverkraft-tech/ci-github-common/actions/create-and-merge-pull-request@9a3d71ca9f68bc1061db8ea1442084ac31a0f8bf # 0.23.0
+      with:
+        github-token: ${{ inputs.github-token }}
+        branch: docs/update-helm-chart-docs-${{ steps.prepare-variables.outputs.working-directory-name }}
+        title: "docs: update Helm chart documentation for ${{ steps.prepare-variables.outputs.working-directory-name }}"
+        body: Clean review apps of ${{ github.event.client_payload.repository }}
+        commit-message: |
+          docs: update Helm chart documentation for ${{ steps.prepare-variables.outputs.working-directory-name }}
+
+          [skip ci]