Skip to content
This repository has been archived by the owner on Aug 25, 2021. It is now read-only.

Add missing newline to code generation #745

Merged
merged 1 commit into from
Dec 17, 2020
Merged

Add missing newline to code generation #745

merged 1 commit into from
Dec 17, 2020

Conversation

lkysow
Copy link
Member

@lkysow lkysow commented Dec 17, 2020

We need to have a newline between the codegen comment and the start of
the generated docs because the markdown formatter will add it later.

Previously we'd generate the docs like:

<!-- codegen: start -->
- `global` ((#v-global)) - Holds values that affect multiple components of the chart.

But when the automatic markdown formatter ran on commit, it would add a newline:

<!-- codegen: start -->

- `global` ((#v-global)) - Holds values that affect multiple components of the chart.

This change ensure we generate the docs with that newline so when the markdown formatter runs it makes no changes. Otherwise when you ran the gen-docs make target it would always make a modification to helm.mdx and remove that newline.

We need to have a newline between the codegen comment and the start of
the generated docs because the markdown formatter will add it later.
@lkysow lkysow requested review from a team, kschoche and thisisnotashwin and removed request for a team December 17, 2020 18:43
Copy link
Contributor

@thisisnotashwin thisisnotashwin left a comment

Choose a reason for hiding this comment

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

💥

Copy link
Contributor

@kschoche kschoche left a comment

Choose a reason for hiding this comment

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

Brilliant!

@lkysow lkysow merged commit 5523886 into master Dec 17, 2020
@lkysow lkysow deleted the helm-docs branch December 17, 2020 19:07
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants