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

Ensure helm chart README.md's are in sync with the go-template #262

Closed
florianrusch-zf opened this issue Apr 20, 2023 · 0 comments · Fixed by #503
Closed

Ensure helm chart README.md's are in sync with the go-template #262

florianrusch-zf opened this issue Apr 20, 2023 · 0 comments · Fixed by #503
Assignees
Labels
enhancement New feature or request gh-actions good first issue Good for newcomers

Comments

@florianrusch-zf
Copy link
Contributor

Is your feature request related to a problem? Please describe.
Currently if someone updates the go-template for our helm charts we don't have any automatism that performs the generation of the README.md files. This is therefore a manual step that could be forgotten or where typos can happen.

Describe the solution you'd like
Add a CI job that checks if both files are in sync with each other.

Describe alternatives you've considered
Automate the creation of the README.md files, but for that the question would be when do we want to do that 🤔 (see discussion in the linked PR below)

Additional context
Was discover in PR #261

@florianrusch-zf florianrusch-zf added enhancement New feature or request good first issue Good for newcomers gh-actions labels Apr 20, 2023
@stephanbcbauer stephanbcbauer moved this to Open in EDC Board Apr 24, 2023
@bcronin90 bcronin90 self-assigned this Jun 16, 2023
@stephanbcbauer stephanbcbauer moved this from Open to In Progress in EDC Board Jun 20, 2023
@github-project-automation github-project-automation bot moved this from In Progress to Done in EDC Board Jun 23, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request gh-actions good first issue Good for newcomers
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

2 participants