Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

automate generation of readme.md #187

Open
nschad opened this issue Jul 30, 2021 · 0 comments · Fixed by #188
Open

automate generation of readme.md #187

nschad opened this issue Jul 30, 2021 · 0 comments · Fixed by #188
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request help wanted Extra attention is needed

Comments

@nschad
Copy link
Collaborator

nschad commented Jul 30, 2021

What this Issue is supposed to do
Basically we want to automate the annoying task of updating the README.md since we use helm-docs for generating the helm value table for the chart. By automatically having a workflow which reacts on every PR we could just generate the README.md for the contributor and automatically add it to the PR (unless they opt-out of us pushing to their fork at which point the workflow would just fail)

Issues we encountered

  • Workflows are not run if its triggered by a workflow unless you are pushing with a PAT
  • Setting skip ci on the updated README.md commit message causes the whole workflow to seize up since a now required workflow (the ct/lint job) is skipped
  • Ignoring ct/lint jobs for none code-changes PRs (just documentation) leads to the same problem as above

Solutions

  • Having an Action push with PAT (instead of the GITHUB_TOKEN) solves the first problem
@nschad nschad added documentation Improvements or additions to documentation enhancement New feature or request help wanted Extra attention is needed labels Jul 30, 2021
@nschad nschad pinned this issue Aug 25, 2021
@nschad nschad reopened this Sep 10, 2021
@nschad nschad changed the title Automatically generate/update README.md every PR automate generation of readme.md Sep 10, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request help wanted Extra attention is needed
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants