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

Allow descriptions in skipped lines #75

Merged
merged 3 commits into from
Oct 11, 2023
Merged

Conversation

jotamartos
Copy link
Contributor

Description of the change

This change allows including descriptions in the lines that we do not want to include in the readme (@Skip)

Benefits

Allows not including a parameter in the README but including the description in the values.yaml file

Possible drawbacks

None

Applicable issues

Related to this other PR

bitnami/charts#19841

Additional information

Checklist

  • Version bumped in package.json and package-lock.json according to semver.
  • New features are documented in the README.md
  • New features contain a new test at the tests folder
  • All tests pass running npm test

Signed-off-by: Jota Martos <jotamartos@vmware.com>
Signed-off-by: Jota Martos <jotamartos@vmware.com>
Copy link
Contributor

@fmulero fmulero left a comment

Choose a reason for hiding this comment

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

Thanks a lot @jotamartos I left a little comment. Please take it a look.

README.md Outdated Show resolved Hide resolved
Signed-off-by: Jota Martos <jotamartos@vmware.com>
Copy link
Contributor

@fmulero fmulero left a comment

Choose a reason for hiding this comment

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

LGTM

@fmulero fmulero merged commit 44a4049 into main Oct 11, 2023
1 check passed
@fmulero fmulero deleted the allow-description-in-skip-lines branch October 11, 2023 09:42
pearsonradu pushed a commit to pearsonradu/readme-generator-for-helm that referenced this pull request Oct 17, 2023
…skip-lines

Allow descriptions in skipped lines
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