add workflow to generate README.md

[kd7lxl]

What this PR does:
This adds a Github Action workflow to automate running make (helm-docs) on each PR and committing any changes.

This is a continuation of the work in #183.

Github Actions workflows will not trigger on commits pushed by Github Actions (differentiated by the auto auth token), so this workflow will cause the Lint and Test workflow to not run. Since that is a required workflow, the PR cannot be merged until Lint and Test is triggered some other way, like closing and reopening the PR. I've left this PR in draft mode while we try to find the best solution to automate running make without defeating the required PR status checks.

Which issue(s) this PR fixes:
Fixes #187

[nschad]

We will have to test it here but maybe this will do the trick

on:
  push:
    paths-ignore:
      - 'README.md*'
      - 'docs/**'
      - 'tools/**'
    branches:
      // kinda pointless, nobody should ever push to main/master
      - main
      - master
  pull_request:

and readme.yml workflow

on:
push:
  paths:
    - 'README.md*'
    - values.yaml
pull_request:

Also I am not completely sure what happens when the ci test workflow is not run the 2nd time. Is the check just skipped? Is it marked as failed? Does the infinite-loop protection not even bother to check if it has to run the workflow (then it wouldn't work anyway)?

[kd7lxl]

Also I am not completely sure what happens when the ci test workflow is not run the 2nd time. Is the check just skipped?

Yes, it is just skipped, so it stays 🟠 indefinitely.

[kd7lxl]

on:
  push:
    branches:
      // kinda pointless, nobody should ever push to main/master
      - main
      - master

BTW, this would run any time a PR was merged to main/master. If it tries to commit, it will fail since branch protection is enabled.

[nschad]

on:
  push:
    branches:
      // kinda pointless, nobody should ever push to main/master
      - main
      - master

BTW, this would run any time a PR was merged to main/master. If it tries to commit, it will fail since branch protection is enabled.

yep thats why I added the comment. I am gonna ask some people, maybe somebody has a bright idea

[nschad]

this should fix our infinite-loop problem @kd7lxl

[kd7lxl]

lgtm!

[nschad]

Alright I think its fine currently how it is @kd7lxl
Do you wanna give your final Approval or do you have any objections?

[kd7lxl]

lgtm