dnskr opened a new pull request, #23726:
URL: https://github.com/apache/superset/pull/23726

   ### 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)](https://helm.sh/docs/chart_best_practices/templates/#comments-yaml-comments-vs-template-comments):
   > YAML comments may be used when it is useful for Helm users to (possibly) 
see the comments during debugging
   
   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
   ```shell
   $ helm template superset helm/superset
   ---
   # Source: superset/templates/service.yaml
   #
   # Licensed to the Apache Software Foundation (ASF) under one or more
   # contributor license agreements.  See the NOTICE file distributed with
   # this work for additional information regarding copyright ownership.
   # The ASF licenses this file to You under the Apache License, Version 2.0
   # (the "License"); you may not use this file except in compliance with
   # the License.  You may obtain a copy of the License at
   #
   #    http://www.apache.org/licenses/LICENSE-2.0
   #
   # Unless required by applicable law or agreed to in writing, software
   # distributed under the License is distributed on an "AS IS" BASIS,
   # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   # See the License for the specific language governing permissions and
   # limitations under the License.
   #
   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
   ```
   #### After
   ```shell
   $ 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.
   ```shell
   helm template superset helm/superset
   ```
   
   ### ADDITIONAL INFORMATION
   <!--- Check any relevant boxes with "x" -->
   <!--- HINT: Include "Fixes #nnn" if you are fixing an existing issue -->
   - [ ] Has associated issue:
   - [ ] Required feature flags:
   - [ ] Changes UI
   - [ ] Includes DB Migration (follow approval process in 
[SIP-59](https://github.com/apache/superset/issues/13351))
     - [ ] Migration is atomic, supports rollback & is backwards-compatible
     - [ ] Confirm DB migration upgrade and downgrade tested
     - [ ] Runtime estimates and downtime expectations provided
   - [ ] Introduces new feature or API
   - [ ] Removes existing feature or API
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]


---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]

Reply via email to