Generate chart README.md with helm-docs

[k0da]

Extend chart values comments and use them as description for helm-docs
generated README

Fixes #359

Signed-off-by: Dinar Valeev dinar.valeev@absa.africa

[ytsarev]

looks indeed cool. Candidate for the pipeline to automatically keep docs in sync?

[k0da]

This is extended now to do it in a PR fassion. Once chart changes are commited to master, PR will be opened with updated Helm Docs. No user intervention needed.

[jkremser]

it would be really cool if the helm-docs tool supported some variables and we could parametrize this URL, because they will be stale soon and actually they sunset the docs for older versions of k8s. It's not related to your change, though.

[k0da]

looks indeed cool. Candidate for the pipeline to automatically keep docs in sync?

Done

[somaritane]

@k0da cool GHA :)
Just a small wording suggestion:

Suggested change

	title: "Generate Helm Docs"
	title: "Update Helm Docs"

"Generate" feels like it might be generated but not necessarily updated in the end.

[somaritane]

It would be cool if we can refer to the "originator" PR in the title or description, but I'm not sure how we can do this at this stage (push to master).

[k0da]

In theory we can, but this blows scope of PR a lot. Lets start small first

[jkremser]

there is that

      - name: Check PR
        run: |
          echo "Pull Request Number - ${{ steps.cpr.outputs.pull-request-number }}"
          echo "Pull Request URL - ${{ steps.cpr.outputs.pull-request-url }}"

where cpr is the id of that pull request step. It's not title, though. It relies on the output of the step so I guess, it's not even possible to have it in the title (chicken-egg)

[k0da]

Yes, something like that, but we need to find it in one of the steps. This will be run on push to master. PR scope is lost at this point

[k0da]

@somaritane done

[kuritka]

@k0da , do we keep the target than ?

PHONY: helm-docs
helm-docs:
	helm-docs -c chart/k8gb

[k0da]

I can drop it

[k0da]

@kuritka done

[jkremser]

@jkremser we don't have PR#, it doesn't run as PR job. we have to find commits witch changes charts/k8gb/* and find last PR. Since this is mostly cosmetics, I'd do that after "main" action is in place already.

That's what the step, I've posted, actually does :) The peter-evans/create-pull-request@v3 action exposes the PR url and PR number implicitly (docs), no need to do it manually by finding commits/prs.

PR scope is lost at this point

that's why the id reference

here is the full version:

.github/workflows/helm_docs.yaml

name: Helm docs
on:
  push:
    branches:
    - 'master'
    paths:
     - 'chart/k8gb/**'
jobs:
  build-helm-doc:
    name: Update Helm Doc
    runs-on: ubuntu-latest
    steps:
    - name: Checkout Code
      uses: actions/checkout@v2
    - name: Check all charts README.md
      uses: docker://jnorwood/helm-docs:v1.5.0
    - name: Create Pull Request
      id: foo
      uses: peter-evans/create-pull-request@v3
      with:
        title: "Update Helm Docs"
        branch: ci-helm-doc
        delete-branch: true
        base: master
        signoff: true
        token: ${{ secrets.GITHUB_TOKEN }}
     - name: Echo PR info
       run: |
          echo "Pull Request Number - ${{ steps.foo.outputs.pull-request-number }}"
          echo "Pull Request URL - ${{ steps.foo.outputs.pull-request-url }}"

btw. no need to do that in this PR, lgtm, good stuff

[kuritka]

I'm looking forward to seeing it 👍