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

[Feat]: Add skip-footer-version flag #252

Open
stevehipwell opened this issue Jul 8, 2024 · 2 comments
Open

[Feat]: Add skip-footer-version flag #252

stevehipwell opened this issue Jul 8, 2024 · 2 comments
Assignees
Labels
enhancement New feature or request triage Issues that need to be triaged and categorized

Comments

@stevehipwell
Copy link
Contributor

General Summary

The new skip-version-footer flag solves the issue with the generated docs changing with new helm-docs versions but does so by removing the whole footer instead of only fixing the source of the problem. I'd like to keep the footer but remove the helm-docs version which was used for generation as having a footer to say that the docs were generated with helm-docs is really useful.

Is your feature request related to a problem? Please describe and/or link to a bug issue.

I'd like my docs to have a footer attributing them to helm-docs without the helm-docs version used to generate them embedded in it. This is because my automation checks the docs diff and expects there to be no changes or it blocks as an error.

Expected Behavior

I should be able to set a flag to always get reproducible docs which include a footer without needing to override the whole default template for every chart.

Current Behavior

I have to duplicate the whole template for all charts to remove the version from the footer.

Possible Solution

I'd like to see a new flag skip-footer-version added to remove the version of helm-docs used from the footer without removing the whole footer.

Alternatives you've considered

See above.

Further Information

No response

@stevehipwell stevehipwell added enhancement New feature or request triage Issues that need to be triaged and categorized labels Jul 8, 2024
@norwoodj
Copy link
Owner

norwoodj commented Jul 8, 2024

Hey, I think this is reasonable. I'd take a look at a PR if you made one.

@stevehipwell
Copy link
Contributor Author

@norwoodj I think this would actually require more changes to the structure of the system than I thought. After reading through the code again I've managed to get a shared template working for my use case so I don't think I've got the time to warrant doing the work for this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request triage Issues that need to be triaged and categorized
Projects
None yet
Development

No branches or pull requests

3 participants