fix(scripts/helm-docs): ignore dependency helm charts when generating README.md #435
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
niladrih
requested review from
tiagolobocastro,
Abhinandan-Purkait and
datacore-vvarakantham
This was referenced Mar 14, 2024
Abhinandan-Purkait
approved these changes
Mar 14, 2024
tiagolobocastro
approved these changes
Mar 14, 2024
|
bors merge |
bors-openebs-mayastor bot
pushed a commit
that referenced
this pull request
Mar 14, 2024
435: fix(scripts/helm-docs): ignore dependency helm charts when generating README.md r=niladrih a=niladrih The script `/scripts/helm/generate-readme.sh` generates documentation for all charts present inside the `/chart` directory. The `helm-docs` tool recursively walks through all charts in the directory and generates docs for them. This is inconvenient if there are dependency charts inside the `/chart/charts` directory. We don't necessarily want to add documentation for these charts to the README.md The `-g` option disables this. ```console -g, --chart-to-generate strings List of charts that will have documentation generated. Comma separated, no space. Empty list - generate for all charts in chart-search-root ``` Co-authored-by: Niladri Halder <niladri.halder26@gmail.com>
|
bors merge |
|
Already running a review |
|
bors cancel |
|
Canceled. |
|
bors merge |
bors-openebs-mayastor bot
pushed a commit
that referenced
this pull request
Mar 14, 2024
435: fix(scripts/helm-docs): ignore dependency helm charts when generating README.md r=niladrih a=niladrih The script `/scripts/helm/generate-readme.sh` generates documentation for all charts present inside the `/chart` directory. The `helm-docs` tool recursively walks through all charts in the directory and generates docs for them. This is inconvenient if there are dependency charts inside the `/chart/charts` directory. We don't necessarily want to add documentation for these charts to the README.md The `-g` option disables this. ```console -g, --chart-to-generate strings List of charts that will have documentation generated. Comma separated, no space. Empty list - generate for all charts in chart-search-root ``` Co-authored-by: Niladri Halder <niladri.halder26@gmail.com>
|
Build failed: |
… README.md Signed-off-by: Niladri Halder <niladri.halder26@gmail.com>
|
bors merge |
|
🕐 Waiting for PR status (Github check) to be set, probably by CI. Bors will automatically try to run when all required PR statuses are set. |
bors-openebs-mayastor bot
pushed a commit
that referenced
this pull request
Mar 14, 2024
435: fix(scripts/helm-docs): ignore dependency helm charts when generating README.md r=niladrih a=niladrih The script `/scripts/helm/generate-readme.sh` generates documentation for all charts present inside the `/chart` directory. The `helm-docs` tool recursively walks through all charts in the directory and generates docs for them. This is inconvenient if there are dependency charts inside the `/chart/charts` directory. We don't necessarily want to add documentation for these charts to the README.md The `-g` option disables this. ```console -g, --chart-to-generate strings List of charts that will have documentation generated. Comma separated, no space. Empty list - generate for all charts in chart-search-root ``` Co-authored-by: Niladri Halder <niladri.halder26@gmail.com>
|
bors cancel |
|
Canceled. |
|
bors merge |
|
Build succeeded: |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The script
/scripts/helm/generate-readme.shgenerates documentation for all charts present inside the/chartdirectory. Thehelm-docstool recursively walks through all charts in the directory and generates docs for them. This is inconvenient if there are dependency charts inside the/chart/chartsdirectory. We don't necessarily want to add documentation for these charts to the README.md The-goption disables this.-g, --chart-to-generate strings List of charts that will have documentation generated. Comma separated, no space. Empty list - generate for all charts in chart-search-root