chore(helm): Use template comments for the chart license header #23726
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.
SUMMARY
The PR changes comment type for license headers in the Helm chart template files.
The PR does not change any functionality of the chart.
According to Comments (YAML Comments vs. Template Comments):
Since there is no value in seeing license header during templates debug, it's a good idea to use Template comments instead of YAML comments for license headers.
BEFORE/AFTER SCREENSHOTS OR ANIMATED GIF
Before
After
$ helm template superset helm/superset --- # Source: superset/templates/service.yaml apiVersion: v1 kind: Service metadata: name: superset namespace: default labels: app: superset chart: superset-0.9.2 release: superset heritage: Helm spec: type: ClusterIP ports: - port: 8088 targetPort: http protocol: TCP name: http selector: app: superset release: superset
TESTING INSTRUCTIONS
Check that the following command doesn't print any license headers.
ADDITIONAL INFORMATION