dnskr opened a new pull request, #30569: URL: https://github.com/apache/airflow/pull/30569
The PR changes comment type for license headers in the Helm 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 debug, it might be a good idea to use Template comments instead of YAML comments for license headers. ### Before ```shell $ helm template test chart --- # Source: airflow/templates/jobs/create-user-job-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. ########################################### ## Airflow Create User Job ServiceAccount ########################################### kind: ServiceAccount apiVersion: v1 metadata: name: test-airflow-create-user-job labels: tier: airflow component: create-user-job release: test chart: "airflow-1.9.0-dev" heritage: Helm ``` ### After ```shell $ helm template test chart --- # Source: airflow/templates/jobs/create-user-job-serviceaccount.yaml ########################################### ## Airflow Create User Job ServiceAccount ########################################### kind: ServiceAccount apiVersion: v1 metadata: name: test-airflow-create-user-job labels: tier: airflow component: create-user-job release: test chart: "airflow-1.9.0-dev" heritage: Helm ``` ### Alternative What do you think about reformatting license text and use the following header? ```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. */}} ``` -- 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]
