This repository has been archived by the owner on Mar 22, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 22
Migrate to readme-generator for helm maintained by bitnami #431
Merged
marcofranssen
merged 21 commits into
spiffe:main
from
krishnakv:feature/readme-generator-current-values
Sep 8, 2023
+1,111
−809
Merged
Changes from 1 commit
Commits
Show all changes
21 commits
Select commit
Hold shift + click to select a range
66090e9
Updated default values.yaml with available options
209dcb1
Merge branch 'spiffe:main' into main
krishnakv 2a4dd2f
Merge branch 'spiffe:main' into main
krishnakv cd1a011
created values and README with readme-generator
d271e14
merge from main branch changes
ef17b1a
Add latest value changes in main branch here
aa64f68
Create readme-gen script for readme-generator install
17ce988
Add code to generate values tables for subcharts README files
61338fe
Change values files for readme-gen syntax
fe5c44b
Modify values.yaml and README.md files to readme-generator format
9dc5c1c
Renamed readme-gen.sh back to helm-docs.sh
cf54cb4
Ensure npm is installed in helm-docs.sh script
474e97a
Merge with latest changes and fix values.yaml for readme-generator
3509a1c
Fix @params lines and blocks in values files
0e1a9fb
Modify github workflows to use the readme-generator tool.
e436d80
Merge branch 'main' into feature/readme-generator-current-values
krishnakv 8563e24
Fix shellcheck and helm test errors
aa49133
Merge branch 'main' into feature/readme-generator-current-values
krishnakv 4037e52
Fixed typos in values and removed Parameters in README
91f8f4c
Fix changes in sprire chart README file
c581625
Fix docs after update of some doc strings
marcofranssen File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Create readme-gen script for readme-generator install
Signed-off-by: Krishnakumar Venkataraman <krishna_kumar08@infosys.com>
There are no files selected for viewing
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
#!/usr/bin/env bash | ||
|
||
set -euo pipefail | ||
|
||
SCRIPTPATH=$(dirname "$0") | ||
README_GENERATOR_VERSION="2.5.1" | ||
README_GENERATOR_EXE="readme-generator" | ||
|
||
# platform agnostic npm install, also adds into the path | ||
npm install -g "@bitnami/readme-generator-for-helm@${README_GENERATOR_VERSION}" | ||
marcofranssen marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
if [[ -z '$(type -d "${README_GENERATOR_EXE}")' ]]; then | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This checks against the directory, but not the executable. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Thank you, fixed that. |
||
echo "readme-generator not installed successfully!!" | ||
fi | ||
|
||
# generate docs and show the diff | ||
readme-generator --values="${SCRIPTPATH}/charts/spire/values.yaml" --readme="${SCRIPTPATH}/charts/spire/README.md" | ||
marcofranssen marked this conversation as resolved.
Show resolved
Hide resolved
|
||
git diff --exit-code | ||
|
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
can we replace the original file
helm-docs.sh
instead of adding a new file? This way we don't have to update contributing.md as well the pipeline remains to work and safegaurds us for outdated docs.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The readme file is available at the bitnami readme-generator-for-helm repo. There are a limited number of tags "@param", "@Skip", "@section", "@extra" etc.
There is also only support for generating the values table under the "## Parameters" section in README.md. Other templating options such as introducing maintainers, chart version and other details into the README is not supported.
There is the option to divide the docs into different sections using "@section" tags. I have also retained the filename for helm-docs.sh.
All the values files including sub-charts are updated, so this PR can be taken for a test drive on your local setup. :-)