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

   ### _Why are the changes needed?_
   The changes are needed to avoid rendering license headers when debugging the 
chart templates.
   
   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 during debug, it's a good idea to 
use Template comments instead of YAML comments.
   
   ### Before
   ```shell
   $ helm template test charts/kyuubi
   ---
   # Source: kyuubi/templates/kyuubi-serviceaccount.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: ServiceAccount
   metadata:
     name: test
     labels:
       helm.sh/chart: kyuubi-0.1.0
       app.kubernetes.io/name: kyuubi
       app.kubernetes.io/instance: test
       app.kubernetes.io/version: "1.7.0"
       app.kubernetes.io/managed-by: Helm
   ---
   ```
   ### After
   ```shell
   $ helm template test charts/kyuubi
   ---
   # Source: kyuubi/templates/kyuubi-serviceaccount.yaml
   apiVersion: v1
   kind: ServiceAccount
   metadata:
     name: test
     labels:
       helm.sh/chart: kyuubi-0.1.0
       app.kubernetes.io/name: kyuubi
       app.kubernetes.io/instance: test
       app.kubernetes.io/version: "1.7.0"
       app.kubernetes.io/managed-by: Helm
   ---
   ```
   
   ### _How was this patch tested?_
   - [ ] Add some test cases that check the changes thoroughly including 
negative and positive cases if possible
   
   - [ ] Add screenshots for manual tests if appropriate
   
   - [ ] [Run 
test](https://kyuubi.readthedocs.io/en/master/develop_tools/testing.html#running-tests)
 locally before make a pull request
   


-- 
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