-
Notifications
You must be signed in to change notification settings - Fork 1.6k
✨ (helm/v2-alpha): Add Notes.txt #5392
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
base: master
Are you sure you want to change the base?
Conversation
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: camilamacedo86 The full list of commands accepted by this bot can be found here. The pull request process is described here DetailsNeeds approval from an approver in each of these files:
Approvers can indicate their approval by writing |
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.
Pull request overview
Adds a Helm chart NOTES.txt scaffold to the helm/v2-alpha plugin so generated charts include a post-install message, and updates docs/testdata accordingly.
Changes:
- Scaffold
templates/NOTES.txtduring Helm chart generation (with--forceoverwrite behavior). - Add unit tests for the new
Notestemplate scaffold (Ginkgo suite + specs). - Update plugin documentation and generated testdata charts to include
NOTES.txt.
Reviewed changes
Copilot reviewed 5 out of 9 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| testdata/project-v4-with-plugins/dist/chart/templates/NOTES.txt | Expected generated Helm chart notes output for testdata project. |
| pkg/plugins/optional/helm/v2alpha/scaffolds/internal/templates/chart-templates/suite_test.go | Adds a Ginkgo suite for the charttemplates package tests. |
| pkg/plugins/optional/helm/v2alpha/scaffolds/internal/templates/chart-templates/notes_test.go | Adds unit tests validating Notes scaffold path, overwrite behavior, and template content. |
| pkg/plugins/optional/helm/v2alpha/scaffolds/internal/templates/chart-templates/notes.go | Implements the Notes scaffold that generates templates/NOTES.txt. |
| pkg/plugins/optional/helm/v2alpha/scaffolds/edit_kustomize.go | Wires the new Notes scaffold into the standard chart file generation flow. |
| docs/book/src/plugins/available/helm-v2-alpha.md | Documents the new NOTES.txt behavior and chart structure updates. |
| docs/book/src/multiversion-tutorial/testdata/project/dist/chart/templates/NOTES.txt | Updates tutorial testdata chart output to include NOTES.txt. |
| docs/book/src/getting-started/testdata/project/dist/chart/templates/NOTES.txt | Updates tutorial testdata chart output to include NOTES.txt. |
| docs/book/src/cronjob-tutorial/testdata/project/dist/chart/templates/NOTES.txt | Updates tutorial testdata chart output to include NOTES.txt. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
pkg/plugins/optional/helm/v2alpha/scaffolds/internal/templates/chart-templates/notes.go
Show resolved
Hide resolved
pkg/plugins/optional/helm/v2alpha/scaffolds/internal/templates/chart-templates/notes_test.go
Outdated
Show resolved
Hide resolved
pkg/plugins/optional/helm/v2alpha/scaffolds/internal/templates/chart-templates/notes_test.go
Show resolved
Hide resolved
1a6fcfe to
7225d05
Compare
7225d05 to
ad057fe
Compare
No description provided.