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

docs: update helm-docs from 1.8.1 to 1.10.0 #697

Merged
merged 2 commits into from
May 31, 2022

Conversation

hairmare
Copy link
Contributor

@hairmare hairmare commented May 31, 2022

Description

Updates helm-docs from 1.8.1 to 1.10.0 and updates any generated READMEs to match.

Removal of (int) in some cases is a bugfix from helm-docs, the change wrt ## is basically a workaround for norwoodj/helm-docs#148 but i'm pretty happy with the results anyways.

Relase Notes

Issues

Checklist

  • This PR contains a description of the changes I'm making
  • I updated the version in Chart.yaml
  • I updated applicable README.md files using pre-commit run
  • I documented any high-level concepts I'm introducing in docs/
  • CI is currently green and this is ready for review
  • I am ready to test changes after they are applied and released

@github-actions github-actions bot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label May 31, 2022
@hairmare hairmare marked this pull request as ready for review May 31, 2022 09:26
@hairmare hairmare requested review from inisitijitty and luk43 and removed request for a team, michaelimfeld, aziiee, trowik, vmaillot and inisitijitty May 31, 2022 09:26
@eyenx
Copy link
Member

eyenx commented May 31, 2022

Shouldn't we wait until the bugs are fixed in probably 1.10.1 ?

@hairmare
Copy link
Contributor Author

Shouldn't we wait until the bugs are fixed in probably 1.10.1 ?

why, the changes fix more than they break. using ## was never a doxed feature

@eyenx
Copy link
Member

eyenx commented May 31, 2022

Shouldn't we wait until the bugs are fixed in probably 1.10.1 ?

why, the changes fix more than they break. using ## was never a doxed feature

okay. Was only thinking about that integer() thingy

Copy link
Contributor

@luk43 luk43 left a comment

Choose a reason for hiding this comment

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

👍

@hairmare
Copy link
Contributor Author

why, the changes fix more than they break. using ## was never a doxed feature

okay. Was only thinking about that integer() thingy

that was a real bug, the type hasit's own column and should not be prefixed to the description

@hairmare hairmare merged commit 7e0aeb9 into adfinis:main May 31, 2022
@hairmare hairmare deleted the chore/bump-helm-docs branch May 31, 2022 13:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants