Skip to content

feat(docs): Generate README.md with helm-docs#106

Closed
jbuck wants to merge 0 commit into
mainfrom
jbuck/push-mqlvvkoltppo
Closed

feat(docs): Generate README.md with helm-docs#106
jbuck wants to merge 0 commit into
mainfrom
jbuck/push-mqlvvkoltppo

Conversation

@jbuck

@jbuck jbuck commented Oct 23, 2025

Copy link
Copy Markdown
Member

Uses https://github.com/norwoodj/helm-docs to generate the values table. I think this could be pretty handy!

@jbuck jbuck requested a review from a team as a October 23, 2025 16:29
@jbuck jbuck force-pushed the jbuck/push-mqlvvkoltppo branch 2 times, most recently from d9dae2a to f977099 Compare October 27, 2025 04:31
Comment on lines +28 to +29
- run: uvx pre-commit run --show-diff-on-failure --color=always --all-files
shell: bash

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You'll definitely need to update dependencies before the unit tests will work in this step. We have a Makefile target called update-dependencies that can be run to help with this.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We'll also need Helm installed with the unittest plugin. I installed those and updated dependencies here if you wanted to steal it: https://github.com/mozilla/helm-charts/blob/main/.github/workflows/unit-tests.yaml#L25-L32

Although I'm sure you could do this more elegantly. :)

@emaydeck-mozilla

Copy link
Copy Markdown
Contributor

Closing this as I need to rewrite history. I saved the diff of the parts that matter to a patch file locally, so I can recreate this again afterwards if necessary.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants