| # 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. |
| --- |
| default_stages: [commit, push] |
| default_language_version: |
| # force all unspecified python hooks to run python3 |
| python: python3 |
| minimum_pre_commit_version: "1.20.0" |
| repos: |
| - repo: https://github.com/Lucas-C/pre-commit-hooks |
| rev: v1.1.7 |
| hooks: |
| - id: forbid-tabs |
| exclude: ^airflow/_vendor/.*$|^docs/Makefile$ |
| - id: insert-license |
| name: Add license for all SQL files |
| files: \.sql$ |
| exclude: ^\.github/.*$|^airflow/_vendor/.*$ |
| args: |
| - --comment-style |
| - "/*||*/" |
| - --license-filepath |
| - license-templates/LICENSE.txt |
| - --fuzzy-match-generates-todo |
| - id: insert-license |
| name: Add license for all other files |
| exclude: ^\.github/.*$"|^airflow/_vendor/.*$ |
| args: |
| - --comment-style |
| - "|#|" |
| - --license-filepath |
| - license-templates/LICENSE.txt |
| - --fuzzy-match-generates-todo |
| files: > |
| \.properties$|\.cfg$|\.conf$|\.ini$|\.ldif$|\.readthedocs$|\.service$|^Dockerfile.*$ |
| - id: insert-license |
| name: Add license for all rst files |
| exclude: ^\.github/.*$"|^airflow/_vendor/.*$ |
| args: |
| - --comment-style |
| - "||" |
| - --license-filepath |
| - license-templates/LICENSE.rst |
| - --fuzzy-match-generates-todo |
| files: \.rst$ |
| - id: insert-license |
| name: Add license for all JS/CSS files |
| files: \.(js|css)$ |
| exclude: ^\.github/.*$|^airflow/_vendor/.*$ |
| args: |
| - --comment-style |
| - "/**| *| */" |
| - --license-filepath |
| - license-templates/LICENSE.txt |
| - --fuzzy-match-generates-todo |
| - id: insert-license |
| name: Add license for all JINJA template files |
| files: ^airflow/www/templates/.*\.html$|^docs/templates/.*\.html$|^airflow/contrib/plugins/metastore_browser/templates/.*\.html$ # yamllint disable-line rule:line-length |
| exclude: ^\.github/.*$|^airflow/_vendor/.*$ |
| args: |
| - --comment-style |
| - "{#||#}" |
| - --license-filepath |
| - license-templates/LICENSE.txt |
| - --fuzzy-match-generates-todo |
| - id: insert-license |
| name: Add license for all shell files |
| exclude: ^\.github/.*$"|^airflow/_vendor/.*$ |
| files: ^breeze$|^breeze-complete$|\.sh$|\.bash$|\.bats$ |
| args: |
| - --comment-style |
| - "|#|" |
| - --license-filepath |
| - license-templates/LICENSE.txt |
| - --fuzzy-match-generates-todo |
| - id: insert-license |
| name: Add license for all python files |
| exclude: ^\.github/.*$"|^airflow/_vendor/.*$ |
| types: [python] |
| args: |
| - --comment-style |
| - "|#|" |
| - --license-filepath |
| - license-templates/LICENSE.txt |
| - --fuzzy-match-generates-todo |
| - id: insert-license |
| name: Add license for all XML files |
| exclude: ^\.github/.*$"|^airflow/_vendor/.*$ |
| types: [xml] |
| args: |
| - --comment-style |
| - "<!--||-->" |
| - --license-filepath |
| - license-templates/LICENSE.txt |
| - --fuzzy-match-generates-todo |
| - id: insert-license |
| name: Add license for all yaml files |
| exclude: ^\.github/.*$"|^airflow/_vendor/.*$ |
| types: [yaml] |
| args: |
| - --comment-style |
| - "|#|" |
| - --license-filepath |
| - license-templates/LICENSE.txt |
| - --fuzzy-match-generates-todo |
| - id: insert-license |
| name: Add license for all md files |
| files: \.md$ |
| exclude: ^\.github/.*$|^airflow/_vendor/.*$ |
| args: |
| - --comment-style |
| - "<!--|| -->" |
| - --license-filepath |
| - license-templates/LICENSE.txt |
| - --fuzzy-match-generates-todo |
| - repo: https://github.com/thlorenz/doctoc.git |
| rev: v1.4.0 |
| hooks: |
| - id: doctoc |
| name: Add TOC for md files |
| files: ^README\.md$|^CONTRIBUTING\.md$|^UPDATING.md$|^dev/README.md$ |
| args: |
| - "--maxlevel" |
| - "2" |
| - repo: meta |
| hooks: |
| - id: check-hooks-apply |
| - repo: https://github.com/pre-commit/pre-commit-hooks |
| rev: v2.5.0 |
| hooks: |
| - id: check-merge-conflict |
| - id: debug-statements |
| - id: detect-private-key |
| - id: end-of-file-fixer |
| - id: mixed-line-ending |
| - id: check-executables-have-shebangs |
| - id: check-xml |
| - id: trailing-whitespace |
| - id: fix-encoding-pragma |
| args: |
| - --remove |
| exclude: ^airflow/_vendor/.*$ |
| - repo: https://github.com/pre-commit/pygrep-hooks |
| rev: v1.4.4 |
| hooks: |
| - id: rst-backticks |
| - id: python-no-log-warn |
| - repo: local |
| hooks: |
| - id: yamllint |
| name: Check yaml files with yamllint |
| entry: yamllint -c yamllint-config.yml |
| language: python |
| additional_dependencies: ['yamllint'] |
| types: [yaml] |
| exclude: ^.*init_git_sync\.template\.yaml$|^.*airflow\.template\.yaml$ |
| - id: shellcheck |
| name: Check Shell scripts syntax correctness |
| language: docker_image |
| entry: koalaman/shellcheck:stable -x -a |
| files: ^breeze$|^breeze-complete$|\.sh$|^hooks/build$|^hooks/push$|\.bash$|\.bats$ |
| exclude: ^airflow/_vendor/.*$ |
| - id: lint-dockerfile |
| name: Lint dockerfile |
| language: system |
| entry: "./scripts/ci/pre_commit_lint_dockerfile.sh" |
| files: ^Dockerfile.*$ |
| pass_filenames: true |
| - id: isort |
| name: Run isort to sort imports |
| language: python |
| entry: isort |
| files: \.py$ |
| # To keep consistent with the global isort skip config defined in setup.cfg |
| exclude: ^airflow/_vendor/.*$|^build/.*$|^.tox/.*$|^venv/.*$ |
| additional_dependencies: ['isort'] |
| - id: setup-order |
| name: Checks for an order of dependencies in setup.py |
| language: python |
| files: ^setup.py$ |
| pass_filenames: false |
| require_serial: true |
| entry: tests/test_order_setup.py |
| - id: update-breeze-file |
| name: Update output of breeze command in BREEZE.rst |
| entry: "./scripts/ci/pre_commit_breeze_cmd_line.sh" |
| language: system |
| files: ^BREEZE.rst$|^breeze$|^breeze-complete$ |
| pass_filenames: false |
| require_serial: true |
| - id: update-local-yml-file |
| name: Update mounts in the local yml file |
| entry: "./scripts/ci/pre_commit_local_yml_mounts.sh" |
| language: system |
| files: ^scripts/ci/_utils.sh$|s^scripts/ci/docker_compose/local.yml" |
| pass_filenames: false |
| require_serial: true |
| - id: update-setup-cfg-file |
| name: Update setup.cfg file with all licenses |
| entry: "./scripts/ci/pre_commit_setup_cfg_file.sh" |
| language: system |
| files: ^setup.cfg$ |
| pass_filenames: false |
| require_serial: true |
| - id: build-providers-dependencies |
| name: Build cross-dependencies for providers packages |
| entry: "./scripts/ci/pre_commit_build_providers_dependencies.sh" |
| language: system |
| files: ^airflow/providers/.*\.py$|^tests/providers/.*\.py$ |
| pass_filenames: false |
| require_serial: true |
| - id: update-extras |
| name: Update extras in documentation |
| entry: "./scripts/ci/pre_commit_update_extras.sh" |
| language: system |
| files: ^setup.py$|^INSTALL$|^CONTRIBUTING.rst$ |
| pass_filenames: false |
| require_serial: true |
| - id: pydevd |
| language: pygrep |
| name: Check for pydevd debug statements accidentally left |
| entry: "pydevd.*settrace\\(" |
| pass_filenames: true |
| files: \.py$ |
| - id: consistent-pylint |
| language: pygrep |
| name: Check for inconsitent pylint disable/enable without space |
| entry: "pylint:disable|pylint:enable" |
| pass_filenames: true |
| files: \.py$ |
| - id: base-operator |
| language: pygrep |
| name: Make sure BaseOperator[Link] is imported from airflow.models.baseoperator in core |
| entry: "from airflow\\.models import.* BaseOperator" |
| files: \.py$ |
| pass_filenames: true |
| exclude: > |
| (?x) |
| ^airflow/gcp/.*$| |
| ^airflow/hooks/.*$| |
| ^airflow/operators/.*$| |
| ^airflow/sensors/.*$| |
| ^airflow/providers/.*$| |
| ^airflow/contrib/.*$ |
| - id: base-operator |
| language: pygrep |
| name: Make sure BaseOperator[Link] is imported from airflow.models outside of core |
| entry: "from airflow\\.models\\.baseoperator import.* BaseOperator" |
| pass_filenames: true |
| files: > |
| (?x) |
| ^airflow/gcp/.*$| |
| ^airflow/hooks/.*$| |
| ^airflow/operators/.*$| |
| ^airflow/sensors/.*$| |
| ^airflow/providers/.*\.py$| |
| ^airflow/contrib/.*\.py$ |
| - id: provide-create-sessions |
| language: pygrep |
| name: To avoid import cycles make sure provide_session and create_session are imported from airflow.utils.session # yamllint disable-line rule:line-length |
| entry: "from airflow\\.utils\\.db import.* (provide_session|create_session)" |
| files: \.py$ |
| pass_filenames: true |
| - id: incorrect-use-of-LoggingMixin |
| language: pygrep |
| name: Make sure LoggingMixin is not used alone |
| entry: "LoggingMixin\\(\\)" |
| files: \.py$ |
| pass_filenames: true |
| - id: daysago-import-check |
| language: pygrep |
| name: Make sure days_ago is imported from airflow.utils.dates |
| entry: "(airflow\\.){0,1}utils\\.dates\\.days_ago" |
| files: \.py$ |
| pass_filenames: true |
| - id: build |
| name: Check if image build is needed |
| entry: ./scripts/ci/pre_commit_ci_build.sh 3.6 false |
| language: system |
| always_run: true |
| pass_filenames: false |
| - id: check-apache-license |
| name: Check if licenses are OK for Apache |
| entry: "./scripts/ci/pre_commit_check_license.sh" |
| language: system |
| files: ^.*LICENSE.*$|^.*LICENCE.*$ |
| pass_filenames: false |
| require_serial: true |
| - id: airflow-config-yaml |
| name: Checks for consistency between config.yml and default_config.cfg |
| language: python |
| files: "config.yml$|default_airflow.cfg$|default.cfg$" |
| pass_filenames: false |
| require_serial: false |
| entry: scripts/ci/pre_commit_yaml_to_cfg.py |
| additional_dependencies: ['pyyaml'] |
| - id: mypy |
| name: Run mypy |
| language: system |
| entry: "./scripts/ci/pre_commit_mypy.sh" |
| files: \.py$ |
| exclude: ^airflow/_vendor/.*$|^dev|^backport_packages |
| require_serial: true |
| - id: pylint |
| name: Run pylint for main sources |
| language: system |
| entry: "./scripts/ci/pre_commit_pylint_main.sh" |
| files: \.py$ |
| exclude: ^tests/.*\.py$|^airflow/_vendor/.*|^scripts/.*\.py$|^dev|^backport_packages |
| pass_filenames: true |
| require_serial: true # Pylint tests should be run in one chunk to detect all cycles |
| - id: pylint-tests |
| name: Run pylint for tests |
| language: system |
| entry: "./scripts/ci/pre_commit_pylint_tests.sh" |
| files: ^tests/.*\.py$ |
| pass_filenames: true |
| require_serial: true |
| - id: flake8 |
| name: Run flake8 |
| language: system |
| entry: "./scripts/ci/pre_commit_flake8.sh" |
| files: \.py$ |
| pass_filenames: true |
| - id: bat-tests |
| name: Run BATS bash tests for changed bash files |
| language: system |
| entry: "./scripts/ci/pre_commit_bat_tests.sh" |
| files: ^breeze$|^breeze-complete$|\.sh$|\.bash$ |
| pass_filenames: false |
