Enforce strict rules for yamllint (#11709)

apache · Oct 21, 2020 · 53e6062 · 53e6062
1 parent ffc9aeb
commit 53e6062
Show file tree

Hide file tree

Showing 20 changed files with 75 additions and 56 deletions.
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
@@ -1,3 +1,4 @@
+---
 blank_issues_enabled: false
 contact_links:
  - name: Ask a question or get support

diff --git a/.github/workflows/build-images-workflow-run.yml b/.github/workflows/build-images-workflow-run.yml
@@ -17,7 +17,7 @@
 #
 ---
 name: "Build Images"
-on:
+on: # yamllint disable-line rule:truthy
  workflow_run:
  workflows: ["CI Build"]
  types: ['requested']
@@ -60,13 +60,13 @@ jobs:
  if: github.repository == 'apache/airflow' || github.event.workflow_run.event != 'schedule'
  steps:
  - name: "Get information about the origin 'CI Build' run"
- uses: potiuk/get-workflow-origin@c657bb36aef4a7402bbe9b2e09a820320f8ff447 # v1
+ uses: potiuk/get-workflow-origin@c657bb36aef4a7402bbe9b2e09a820320f8ff447  # v1
  id: source-run-info
  with:
  token: ${{ secrets.GITHUB_TOKEN }}
  sourceRunId: ${{ github.event.workflow_run.id }}
  - name: "Cancel duplicated 'CI Build' runs"
- uses: potiuk/cancel-workflow-runs@0acb1c01f6740dfbca6eab6e21a5b5066e8bafb3 # v3_3
+ uses: potiuk/cancel-workflow-runs@0acb1c01f6740dfbca6eab6e21a5b5066e8bafb3  # v3_3
  with:
  token: ${{ secrets.GITHUB_TOKEN }}
  cancelMode: duplicates
@@ -84,7 +84,7 @@ jobs:
  # in GitHub Actions, we have to use Job names to match Event/Repo/Branch from the
  # build-info step there to find the duplicates ¯\_(ツ)_/¯.
 
- uses: potiuk/cancel-workflow-runs@0acb1c01f6740dfbca6eab6e21a5b5066e8bafb3 # v3_3
+ uses: potiuk/cancel-workflow-runs@0acb1c01f6740dfbca6eab6e21a5b5066e8bafb3  # v3_3
  with:
  cancelMode: namedJobs
  token: ${{ secrets.GITHUB_TOKEN }}
@@ -105,7 +105,7 @@ jobs:
  # can cancel all the matching "Build Images" workflow runs in the two following steps.
  # Yeah. Adding to the complexity ¯\_(ツ)_/¯.
 
- uses: potiuk/cancel-workflow-runs@0acb1c01f6740dfbca6eab6e21a5b5066e8bafb3 # v3_3
+ uses: potiuk/cancel-workflow-runs@0acb1c01f6740dfbca6eab6e21a5b5066e8bafb3  # v3_3
  id: cancel-failed
  with:
  token: ${{ secrets.GITHUB_TOKEN }}
@@ -140,14 +140,14 @@ jobs:
  # it to cancel any jobs that have matching names containing Source Run Id:
  # followed by one of the run ids. Yes I know it's super complex ¯\_(ツ)_/¯.
  if: env.BUILD_IMAGES == 'true' && steps.source-run-info-failed.outputs.cancelledRuns != '[]'
- uses: potiuk/cancel-workflow-runs@0acb1c01f6740dfbca6eab6e21a5b5066e8bafb3 # v3_3
+ uses: potiuk/cancel-workflow-runs@0acb1c01f6740dfbca6eab6e21a5b5066e8bafb3  # v3_3
  with:
  cancelMode: namedJobs
  token: ${{ secrets.GITHUB_TOKEN }}
  notifyPRCancel: true
  jobNameRegexps: ${{ steps.extract-cancelled-failed-runs.outputs.matching-regexp }}
  - name: "Cancel duplicated 'CodeQL' runs"
- uses: potiuk/cancel-workflow-runs@0acb1c01f6740dfbca6eab6e21a5b5066e8bafb3 # v3_3
+ uses: potiuk/cancel-workflow-runs@0acb1c01f6740dfbca6eab6e21a5b5066e8bafb3  # v3_3
  id: cancel
  with:
  token: ${{ secrets.GITHUB_TOKEN }}
@@ -243,8 +243,8 @@ jobs:
  needs: [build-info, cancel-workflow-runs]
  strategy:
  matrix:
- # We need to attempt to build all possible versions here because workflow_run
- # event is run from master for both master and v1-10-tests
+  # We need to attempt to build all possible versions here because workflow_run
+  # event is run from master for both master and v1-10-tests
  python-version: ${{ fromJson(needs.build-info.outputs.allPythonVersions) }}
  image-type: [CI, PROD]
  fail-fast: true
@@ -296,7 +296,7 @@ jobs:
  echo "::set-output name=proceed::false"
  fi
  - name: Initiate Github Checks for Building image
- uses: LouisBrunner/checks-action@9f02872da71b6f558c6a6f190f925dde5e4d8798 #v1.1.0
+ uses: LouisBrunner/checks-action@9f02872da71b6f558c6a6f190f925dde5e4d8798  # v1.1.0
  id: build-image-check
  with:
  token: ${{ secrets.GITHUB_TOKEN }}
@@ -344,7 +344,7 @@ jobs:
  run: ./scripts/ci/images/ci_push_production_images.sh
  if: matrix.image-type == 'PROD' && steps.defaults.outputs.proceed == 'true'
  - name: Update Github Checks for Building image with status
- uses: LouisBrunner/checks-action@9f02872da71b6f558c6a6f190f925dde5e4d8798 #v1.1.0
+ uses: LouisBrunner/checks-action@9f02872da71b6f558c6a6f190f925dde5e4d8798  # v1.1.0
  if: always() && steps.defaults.outputs.proceed == 'true'
  with:
  token: ${{ secrets.GITHUB_TOKEN }}
@@ -366,7 +366,7 @@ jobs:
  needs: [build-images]
  steps:
  - name: "Canceling the 'CI Build' source workflow in case of failure!"
- uses: potiuk/cancel-workflow-runs@cancel_message #v3
+ uses: potiuk/cancel-workflow-runs@cancel_message  # v3
  with:
  token: ${{ secrets.GITHUB_TOKEN }}
  cancelMode: self
@@ -381,7 +381,7 @@ jobs:
  needs: [build-images]
  steps:
  - name: "Canceling the 'CI Build' source workflow in case of failure!"
- uses: potiuk/cancel-workflow-runs@0acb1c01f6740dfbca6eab6e21a5b5066e8bafb3 # v3_3
+ uses: potiuk/cancel-workflow-runs@0acb1c01f6740dfbca6eab6e21a5b5066e8bafb3  # v3_3
  with:
  token: ${{ secrets.GITHUB_TOKEN }}
  cancelMode: self

diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -17,7 +17,7 @@
 #
 ---
 name: CI Build
-on:
+on: # yamllint disable-line rule:truthy
  schedule:
  - cron: '28 0 * * *'
  push:
@@ -937,7 +937,7 @@ jobs:
  - name: "Commit changed constraint files for ${{needs.build-info.outputs.pythonVersions}}"
  run: ./scripts/ci/constraints/ci_commit_constraints.sh
  - name: "Push changes"
- uses: ad-m/github-push-action@40bf560936a8022e68a3c00e7d2abefaf01305a6 # v0.6.0
+ uses: ad-m/github-push-action@40bf560936a8022e68a3c00e7d2abefaf01305a6  # v0.6.0
  with:
  github_token: ${{ secrets.GITHUB_TOKEN }}
  branch: ${{ steps.constraints-branch.outputs.branch }}
@@ -973,7 +973,7 @@ jobs:
  echo "Tagging ${BRANCH_NAME}"
  git tag -f nightly-${BRANCH_NAME} HEAD
  - name: "Push tags"
- uses: ad-m/github-push-action@40bf560936a8022e68a3c00e7d2abefaf01305a6 # v0.6.0
+ uses: ad-m/github-push-action@40bf560936a8022e68a3c00e7d2abefaf01305a6  # v0.6.0
  with:
  github_token: ${{ secrets.GITHUB_TOKEN }}
  tags: true

diff --git a/.github/workflows/codeql-analysis.yml b/.github/workflows/codeql-analysis.yml
@@ -1,7 +1,7 @@
 ---
 name: "CodeQL"
 
-on:
+on: # yamllint disable-line rule:truthy
  push:
  branches: [master]
  pull_request:

diff --git a/.github/workflows/delete_old_artifacts.yml b/.github/workflows/delete_old_artifacts.yml
@@ -1,14 +1,15 @@
+---
 name: 'Delete old artifacts'
-on:
+on: # yamllint disable-line rule:truthy
  schedule:
- - cron: '27 */6 * * *' # run every 6 hours
+ - cron: '27 */6 * * *'  # run every 6 hours
 
 jobs:
  delete-artifacts:
  runs-on: ubuntu-latest
  if: github.repository == 'apache/airflow'
  steps:
- - uses: kolpav/purge-artifacts-action@04c636a505f26ebc82f8d070b202fb87ff572b10 # v1.0
+ - uses: kolpav/purge-artifacts-action@04c636a505f26ebc82f8d070b202fb87ff572b10  # v1.0
  with:
  token: ${{ secrets.GITHUB_TOKEN }}
- expire-in: 7days # Setting this to 0 will delete all artifacts
+ expire-in: 7days  # Setting this to 0 will delete all artifacts
diff --git a/.github/workflows/repo_sync.yml b/.github/workflows/repo_sync.yml
@@ -17,7 +17,7 @@
 #
 ---
 name: Force sync master from apache/airflow
-on:
+on: # yamllint disable-line rule:truthy
  workflow_dispatch:
 jobs:
  repo-sync:

diff --git a/.github/workflows/scheduled_quarantined.yml b/.github/workflows/scheduled_quarantined.yml
@@ -17,7 +17,7 @@
 #
 ---
 name: Quarantined Build
-on:
+on: # yamllint disable-line rule:truthy
  schedule:
  # Run quarantined builds 4 times a day to gather better quarantine stats
  - cron: '12 */6 * * *'

diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -181,7 +181,7 @@ repos:
  hooks:
  - id: yamllint
  name: Check yaml files with yamllint
- entry: yamllint -c yamllint-config.yml
+ entry: yamllint -c yamllint-config.yml --strict
  types: [yaml]
  exclude:
  ^.*init_git_sync\.template\.yaml$|^.*airflow\.template\.yaml$|^chart/(?:templates|files)/.*\.yaml

diff --git a/airflow/api_connexion/openapi/v1.yaml b/airflow/api_connexion/openapi/v1.yaml
@@ -1510,7 +1510,7 @@ components:
  nullable: true
  state:
  $ref: '#/components/schemas/DagState'
- readOnly: True
+ readOnly: true
  external_trigger:
  type: boolean
  default: true
@@ -1746,7 +1746,7 @@ components:
  type: string
  queued_when:
  type: string
- nullable: True
+ nullable: true
  pid:
  type: integer
  executor_config:

diff --git a/airflow/kubernetes_executor_templates/basic_template.yaml b/airflow/kubernetes_executor_templates/basic_template.yaml
@@ -14,7 +14,7 @@
 # KIND, either express or implied. See the License for the
 # specific language governing permissions and limitations
 # under the License.
-
+---
 kind: Pod
 apiVersion: v1
 metadata:

diff --git a/airflow/providers/cncf/kubernetes/example_dags/example_spark_kubernetes_spark_pi.yaml b/airflow/providers/cncf/kubernetes/example_dags/example_spark_kubernetes_spark_pi.yaml
@@ -15,7 +15,7 @@
 # KIND, either express or implied. See the License for the
 # specific language governing permissions and limitations
 # under the License.
-
+---
 apiVersion: "sparkoperator.k8s.io/v1beta2"
 kind: SparkApplication
 metadata:

diff --git a/airflow/providers/google/cloud/example_dags/example_cloud_build.yaml b/airflow/providers/google/cloud/example_dags/example_cloud_build.yaml
@@ -14,7 +14,7 @@
 # KIND, either express or implied. See the License for the
 # specific language governing permissions and limitations
 # under the License.
-
+---
 steps:
  - name: 'ubuntu'
  args: ['echo', 'Hello {{ params.name}}']
diff --git a/airflow/providers/google/config_templates/config.yml b/airflow/providers/google/config_templates/config.yml
@@ -14,7 +14,7 @@
 # KIND, either express or implied. See the License for the
 # specific language governing permissions and limitations
 # under the License.
-
+---
 - name: providers_google
  description: Options for google provider
  options:

diff --git a/chart/Chart.yaml b/chart/Chart.yaml
@@ -16,6 +16,7 @@
 # under the License.
 
 # apiVersion v1 is Helm 2
+---
 apiVersion: v1
 name: airflow
 version: 1.0.0

diff --git a/chart/dockerfiles/statsd-exporter/mappings.yml b/chart/dockerfiles/statsd-exporter/mappings.yml
@@ -14,7 +14,7 @@
 # KIND, either express or implied. See the License for the
 # specific language governing permissions and limitations
 # under the License.
-
+---
 mappings:
  # Map dot separated stats to labels
  - match: airflow.dagrun.dependency-check.*.*

diff --git a/chart/requirements.yaml b/chart/requirements.yaml
@@ -14,7 +14,7 @@
 # KIND, either express or implied. See the License for the
 # specific language governing permissions and limitations
 # under the License.
-
+---
 dependencies:
  - name: postgresql
  version: 6.3.12

diff --git a/chart/tests/migrate-database-job_test.yaml b/chart/tests/migrate-database-job_test.yaml
@@ -14,7 +14,7 @@
 # KIND, either express or implied. See the License for the
 # specific language governing permissions and limitations
 # under the License.
-
+---
 templates:
  - migrate-database-job.yaml
 tests:

diff --git a/chart/values.yaml b/chart/values.yaml
@@ -450,13 +450,21 @@ pgbouncer:
  config:
  maxUnavailable: 1
 
+ # Limit the resources to pgbouncerExported.
+ # When you specify the resource request the scheduler uses this information to decide which node to place
+ # the Pod on. When you specify a resource limit for a Container, the kubelet enforces those limits so
+ # that the running container is not allowed to use more of that resource than the limit you set.
+ # See: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
+ # Example:
+ #
+ # resource:
+ # limits:
+ # cpu: 100m
+ # memory: 128Mi
+ # requests:
+ # cpu: 100m
+ # memory: 128Mi
  resources: {}
- # limits:
- # cpu: 100m
- # memory: 128Mi
- # requests:
- # cpu: 100m
- # memory: 128Mi
 
  service:
  extraAnnotations: {}
@@ -510,11 +518,13 @@ redis:
 registry:
  secretName: ~
 
+ # Example:
+ # connection:
+ # user: ~
+ # pass: ~
+ # host: ~
+ # email: ~
  connection: {}
- # user: ~
- # pass: ~
- # host: ~
- # email: ~
 
 # Elasticsearch logging configuration
 elasticsearch:
@@ -523,11 +533,14 @@ elasticsearch:
  # A secret containing the connection
  secretName: ~
  # Or an object representing the connection
+ # Example:
+ # connection:
+ # user: ~
+ # pass: ~
+ # host: ~
+ # port: ~
  connection: {}
- # user: ~
- # pass: ~
- # host: ~
- # port: ~
+
 
 # All ports used by chart
 ports:
@@ -689,7 +702,8 @@ dags:
  # GIT_SYNC_USERNAME: <base64_encoded_git_username>
  # GIT_SYNC_PASSWORD: <base64_encoded_git_password>
  # and specify the name of the secret below
- #credentialsSecret: git-credentials
+ #
+ # credentialsSecret: git-credentials
  #
  #
  # If you are using an ssh clone url, you can load
@@ -703,10 +717,12 @@ dags:
  # # key needs to be gitSshKey
  # gitSshKey: <base64_encoded_data>
  # and specify the name of the secret below
- #sshKeySecret: airflow-ssh-secret
+ # sshKeySecret: airflow-ssh-secret
+ #
  # If you are using an ssh private key, you can additionally
  # specify the content of your known_hosts file, example:
- #knownHosts: |
+ #
+ # knownHosts: |
  # <host1>,<ip1> <key1>
  # <host2>,<ip2> <key2>
  # interval between git sync attempts in seconds

diff --git a/codecov.yml b/codecov.yml
@@ -14,7 +14,7 @@
 # KIND, either express or implied. See the License for the
 # specific language governing permissions and limitations
 # under the License.
-
+---
 codecov:
  require_ci_to_pass: true
  notify:
@@ -62,9 +62,9 @@ coverage:
 parsers:
  gcov:
  branch_detection:
- conditional: yes
- loop: yes
- method: no
- macro: no
+ conditional: true
+ loop: true
+ method: false
+ macro: false
 
 comment: false