DEVAI-196: Helm Chart README and JSON Schema generation #26
Conversation
coreydaley
force-pushed
the
2024-11-13-implement-helm-chart-testing
branch
7 times, most recently
from
1781189 to
4cc0ac5
Compare
There was a problem hiding this comment.
This script has been changed from the original found in the backstage/backstage repository since there is no Chart.lock file for it to find, I have updated it to look for the values.schema.json file instead. I have also fixed a few small linting issues that i will try to also fix upstream.
.gitignore
Outdated
There was a problem hiding this comment.
On MacOS, installing Python via homebrew is the way to go, and then creating Python virtual environments for each specific project and install any needed dependencies, which will be documented in the CONTRIBUTING.md file, adding env to the .gitignore should help ensure that the created virtual environment does not get pulled into a pull request accidently.
There was a problem hiding this comment.
This README.md is generated using the helm-docs command using the README.md.gotmpl file, making it probably more useful to leave comments on either this file OR the template file, and not both.
There was a problem hiding this comment.
This file is generated using the jsonschema-dereference script using the values.schema.tmpl.json file, so it would make sense to leave comments on this file OR the template file, and not both.
There was a problem hiding this comment.
The comments added to this file are used to generate the descriptions in the table in the README.md file
coreydaley
force-pushed
the
2024-11-13-implement-helm-chart-testing
branch
from
4cc0ac5 to
7705756
Compare
coreydaley
changed the title
coreydaley
force-pushed
the
2024-11-13-implement-helm-chart-testing
branch
2 times, most recently
from
a6646e4 to
1aa2ad8
Compare
coreydaley
force-pushed
the
2024-11-13-implement-helm-chart-testing
branch
2 times, most recently
from
f7724c8 to
5dd01a0
Compare
coreydaley
changed the title
|
@thepetk this is ready for another look, thanks! |
|
@johnmcollier @gabemontero @thepetk ptal, thanks |
There was a problem hiding this comment.
I played around with the branch and it deploys fine. I like a lot the two checks we are adding. Some comments for the overall experience:
- I feel the readme files of
pipeline-installandpipeline-setupneed to be kept as is. Mostly because they contain information about how someone can install the pipelines and set everything up. With the new content I find it a bit difficult for someone new to feel comfortable to set things up. - I like the approach with the
gotmplandtmplfiles. I think it would be nice to add instructions on how we can use them (sorry if it is already mentioned and I have missed it :( )
coreydaley
force-pushed
the
2024-11-13-implement-helm-chart-testing
branch
from
5dd01a0 to
d3302ea
Compare
|
@thepetk Looks like those README files were getting messed up because of the templating, so i created templates for those also :) Should be good now |
coreydaley
force-pushed
the
2024-11-13-implement-helm-chart-testing
branch
from
d3302ea to
18c9a9d
Compare
Co-authored-by: Theofanis Petkos <[email protected]>
coreydaley
force-pushed
the
2024-11-13-implement-helm-chart-testing
branch
from
18c9a9d to
e84560d
Compare
|
@thepetk I have added a CONTRIBUTING.md file that will hopefully satisfy your second comment. |
coreydaley
changed the title
What does this PR do?:
Which issue(s) this PR fixes:
https://issues.redhat.com/browse/DEVAI-278
https://issues.redhat.com/browse/DEVAI-279
https://issues.redhat.com/browse/DEVAI-280
https://issues.redhat.com/browse/DEVAI-282
PR acceptance criteria:
Testing and documentation do not need to be complete in order for this PR to be approved. We just need to ensure tracking issues are opened and linked to this PR, if they are not in the PR scope due to various constraints.
How to test changes / Special notes to the reviewer: