✨ (helm/v2-alpha): Add Notes.txt#5392
Conversation
k8s-ci-robot
added
approved
There was a problem hiding this comment.
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
camilamacedo86
force-pushed
the
add-notes
branch
from
1a6fcfe to
7225d05
Compare
k8s-ci-robot
added
the
needs-rebase
camilamacedo86
force-pushed
the
add-notes
branch
from
7225d05 to
ad057fe
Compare
k8s-ci-robot
removed
the
needs-rebase
camilamacedo86
force-pushed
the
add-notes
branch
from
ad057fe to
a4eaee9
Compare
|
/override pull-kubebuilder-e2e-k8s-1-35-0 flake and not need those tests |
|
@camilamacedo86: Overrode contexts on behalf of camilamacedo86: pull-kubebuilder-e2e-k8s-1-33-0, pull-kubebuilder-e2e-k8s-1-35-0 DetailsIn response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. |
| | **--manifests** | Path to YAML file containing Kubernetes manifests (default: `dist/install.yaml`) | | ||
| | **--output-dir** string | Output directory for chart (default: `dist`) | | ||
| | **--force** | Regenerates preserved files except `Chart.yaml` (values.yaml, _helpers.tpl, .helmignore, test-chart.yml) | | ||
| | **--force** | Regenerates preserved files except `Chart.yaml` (values.yaml, NOTES.txt, _helpers.tpl, .helmignore, test-chart.yml) | |
There was a problem hiding this comment.
Reformat suggestion, following the formatting in docs/book/src/plugins/available/helm-v2-alpha.md
| | **--force** | Regenerates preserved files except `Chart.yaml` (values.yaml, NOTES.txt, _helpers.tpl, .helmignore, test-chart.yml) | | |
| | **--force** | Regenerates preserved files except `Chart.yaml` (`values.yaml`, `NOTES.txt`, `_helpers.tpl`, `.helmignore`, `test-chart.yml`) | |
| Without --force, the plugin also preserves values.yaml, NOTES.txt, _helpers.tpl, .helmignore, and | ||
| .github/workflows/test-chart.yml. All template files in templates/ are always regenerated |
There was a problem hiding this comment.
| Without --force, the plugin also preserves values.yaml, NOTES.txt, _helpers.tpl, .helmignore, and | |
| .github/workflows/test-chart.yml. All template files in templates/ are always regenerated | |
| Without --force, the plugin also preserves `values.yaml`, `NOTES.txt`, `_helpers.tpl`, `.helmignore`, and | |
| `.github/workflows/test-chart.yml`. All template files in templates/ are always regenerated |
There was a problem hiding this comment.
Here we cannot do this change, that will break the output for the command. (string will broke)
There was a problem hiding this comment.
My bad, got misled by the ** markup
There was a problem hiding this comment.
It is all fine.
I think it is good becuase is how we have the same in other places.
But if you see any hall to improvements please feel free to raise a PR
We love contributions and help ❤️
Really thank you
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: camilamacedo86, mloskot 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 |
camilamacedo86
force-pushed
the
add-notes
branch
from
a4eaee9 to
e10b5c3
Compare
camilamacedo86
added
the
lgtm
No description provided.