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

Autogenerate basic helm readme's for app umbrella charts #452

Merged
merged 2 commits into from
Sep 15, 2023

Conversation

michaeljguarino
Copy link
Member

Summary

This will help at least provide some usable documentation for how to reconfigure helm charts

Test Plan

local tested on a few charts, also swallows errors to avoid blocking plural build

Checklist

  • If required, I have updated the Plural documentation accordingly.
  • I have added tests to cover my changes.
  • I have added a meaningful title and summary to convey the impact of this PR to a user.
  • I have added relevant labels to this PR to help with categorization for release notes.

This will help at least provide some usable documentation for how to reconfigure helm charts
Usage: "output to stdout instead of to a file",
},
},
Action: latestVersion(func(c *cli.Context) error { return appReadme(c.Args().Get(0), c.Bool("dry-run")) }),
Copy link
Member

Choose a reason for hiding this comment

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

would be good to add requireArgs helper

@michaeljguarino michaeljguarino merged commit 4bd34b5 into main Sep 15, 2023
10 of 11 checks passed
@michaeljguarino michaeljguarino deleted the helm-docs branch September 15, 2023 15:20
michaeljguarino added a commit that referenced this pull request Aug 28, 2024
* Autogenerate basic helm readme's for app umbrella charts

This will help at least provide some usable documentation for how to reconfigure helm charts

* bump helm-docs
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants