alex/esp-idf
alex/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2024-10-05 20:47:46 -04:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity
79f0dfeafa
esp-idf/.pre-commit-config.yaml

134 lines
4.5 KiB
YAML
Raw Normal View History

CI: Add pre-commit for esp-idf project. add tools/ci/python_packages/idf_ci.py for some util functions used in ci and needs multi-os solution
2020-10-21 07:30:49 -04:00
# See https://pre-commit.com for more information
# See https://pre-commit.com/hooks.html for more hooks
fix: do sbom manifest validation in post-commit Following commit c3afbebf2316 ("fix: bump esp-idf-sbom to v0.13.0 in pre-commit"), the validation of submodule hash now relies solely on the information recorded in the git-tree. Previously, the hash verification used submodule's working tree hash if available. Since the new submodule hash is recorded in git-tree only after the commit is created, we need to move the check into post-commit, otherwise the hash validation checks the old value. For example: 1. in .gitmodules [submodule "components/json/cJSON"] sbom-hash = cb8693b058ba302f4829ec6d03f609ac6f848546 2. update the cJSON $ git -C components/json/cJSON checkout b45f48e600671feade0b6bd65d1c69de7899f2be 3. update cJSON hash in .gitmodules [submodule "components/json/cJSON"] sbom-hash = b45f48e600671feade0b6bd65d1c69de7899f2be 4. commit the changes $ git commit -a -s Step 4. will fail, because the validation is currently started in pre-commit stage, where the hash for cJSON recorded in git-tree is still cb8693b058ba302f4829ec6d03f609ac6f848546. The new hash b45f48e600671feade0b6bd65d1c69de7899f2be will be stored in git-tree after the new commit is created. Note that this means we cannot prevent the commit creation, but only notify user about the hash inconsistency. If he/she still decides to push it, it will fail in pre-commit checks in CI. Signed-off-by: Frantisek Hrbata <frantisek.hrbata@espressif.com>
2023-12-18 02:08:13 -05:00
default_stages: [commit]
CI: Add pre-commit for esp-idf project. add tools/ci/python_packages/idf_ci.py for some util functions used in ci and needs multi-os solution
2020-10-21 07:30:49 -04:00
repos:
- repo: https://github.com/pre-commit/pre-commit-hooks
fix: Bump up pre-commit hooks version
2024-02-06 07:29:55 -05:00
rev: v4.5.0
CI: Add pre-commit for esp-idf project. add tools/ci/python_packages/idf_ci.py for some util functions used in ci and needs multi-os solution
2020-10-21 07:30:49 -04:00
hooks:
- id: trailing-whitespace
pre-commit: Rearrange the YAML file to avoid the warning Having a root level key that existed only to make an anchor led to a warning, instead create the anchor in the first place the key was used and then reference it later on.
2020-11-12 22:22:18 -05:00
# note: whitespace exclusions use multiline regex, see https://pre-commit.com/#regular-expressions
# items are:
# 1 - some file extensions
# 2 - any file matching *test*/*expected* (for host tests, if possible use this naming pattern always)
# 3 - any directory named 'testdata'
# 4 - IDF monitor test data
protobuf: Fix v4.21.0 (python) compatibility issue - Added auto-generated protobuf files (proto-c and python to pre-commit hook ignore lists
2022-05-27 00:05:46 -04:00
# 5 - protobuf auto-generated files
pre-commit: Rearrange the YAML file to avoid the warning Having a root level key that existed only to make an anchor led to a warning, instead create the anchor in the first place the key was used and then reference it later on.
2020-11-12 22:22:18 -05:00
exclude: &whitespace_excludes |
style(editorconfig): add indent style for yaml
2021-01-22 02:25:22 -05:00
(?x)^(
.+\.(md|rst|map|bin)|
.+test.*\/.*expected.*|
.+\/testdata\/.+|
protobuf: Fix v4.21.0 (python) compatibility issue - Added auto-generated protobuf files (proto-c and python to pre-commit hook ignore lists
2022-05-27 00:05:46 -04:00
.+test_idf_monitor\/tests\/.+|
.*_pb2.py|
.*.pb-c.h|
.*.pb-c.c
style(editorconfig): add indent style for yaml
2021-01-22 02:25:22 -05:00
)$
CI: Add pre-commit for esp-idf project. add tools/ci/python_packages/idf_ci.py for some util functions used in ci and needs multi-os solution
2020-10-21 07:30:49 -04:00
- id: end-of-file-fixer
pre-commit: Rearrange the YAML file to avoid the warning Having a root level key that existed only to make an anchor led to a warning, instead create the anchor in the first place the key was used and then reference it later on.
2020-11-12 22:22:18 -05:00
exclude: *whitespace_excludes
CI: Add pre-commit for esp-idf project. add tools/ci/python_packages/idf_ci.py for some util functions used in ci and needs multi-os solution
2020-10-21 07:30:49 -04:00
- id: check-executables-have-shebangs
- id: mixed-line-ending
args: ['-f=lf']
pre-commit: Add double-quote-string-fixer and isort for python files
2020-12-20 23:42:29 -05:00
- id: double-quote-string-fixer
precommit: update flake8 repo url to use github Gitlab mirror repo has been deprecated.
2022-11-15 00:33:02 -05:00
- repo: https://github.com/PyCQA/flake8
Add copyright check to pre-commit-config
2021-09-08 11:38:14 -04:00
rev: 3.9.2
CI: Add pre-commit for esp-idf project. add tools/ci/python_packages/idf_ci.py for some util functions used in ci and needs multi-os solution
2020-10-21 07:30:49 -04:00
hooks:
- id: flake8
args: ['--config=.flake8', '--tee', '--benchmark']
feat: Use python-reorder-imports instead of isort
2024-01-09 13:52:15 -05:00
- repo: https://github.com/asottile/reorder-python-imports
rev: v3.12.0
pre-commit: Add double-quote-string-fixer and isort for python files
2020-12-20 23:42:29 -05:00
hooks:
feat: Use python-reorder-imports instead of isort
2024-01-09 13:52:15 -05:00
- id: reorder-python-imports
name: Reorder Python imports
args: [--py36-plus]
protobuf: Fix v4.21.0 (python) compatibility issue - Added auto-generated protobuf files (proto-c and python to pre-commit hook ignore lists
2022-05-27 00:05:46 -04:00
exclude: >
(?x)^(
.*_pb2.py
)$
CI: Add pre-commit for esp-idf project. add tools/ci/python_packages/idf_ci.py for some util functions used in ci and needs multi-os solution
2020-10-21 07:30:49 -04:00
- repo: local
hooks:
- id: check-executables
name: Check File Permissions
entry: tools/ci/check_executables.py --action executables
language: python
types: [executable]
exclude: '\.pre-commit/.+'
- id: check-executable-list
name: Validate executable-list.txt
entry: tools/ci/check_executables.py --action list
language: python
pass_filenames: false
always_run: true
- id: check-kconfigs
name: Validate Kconfig files
check_kconfigs and check_deprecated_kconfigs now use files arguments
2020-10-30 05:28:24 -04:00
entry: tools/ci/check_kconfigs.py
CI: Add pre-commit for esp-idf project. add tools/ci/python_packages/idf_ci.py for some util functions used in ci and needs multi-os solution
2020-10-21 07:30:49 -04:00
language: python
check_kconfigs and check_deprecated_kconfigs now use files arguments
2020-10-30 05:28:24 -04:00
files: '^Kconfig$|Kconfig.*$'
CI: Add pre-commit for esp-idf project. add tools/ci/python_packages/idf_ci.py for some util functions used in ci and needs multi-os solution
2020-10-21 07:30:49 -04:00
- id: check-deprecated-kconfigs-options
name: Check if any Kconfig Options Deprecated
check_kconfigs and check_deprecated_kconfigs now use files arguments
2020-10-30 05:28:24 -04:00
entry: tools/ci/check_deprecated_kconfigs.py
CI: Add pre-commit for esp-idf project. add tools/ci/python_packages/idf_ci.py for some util functions used in ci and needs multi-os solution
2020-10-21 07:30:49 -04:00
language: python
check_kconfigs and check_deprecated_kconfigs now use files arguments
2020-10-30 05:28:24 -04:00
files: 'sdkconfig\.ci$|sdkconfig\.rename$|sdkconfig.*$'
CI: Add pre-commit for esp-idf project. add tools/ci/python_packages/idf_ci.py for some util functions used in ci and needs multi-os solution
2020-10-21 07:30:49 -04:00
- id: cmake-lint
name: Check CMake Files Format
cmake: Disable cmakelint indentation checks temporarily
2020-11-08 21:59:18 -05:00
entry: cmakelint --linelength=120 --spaces=4 --filter=-whitespace/indent
CI: Add pre-commit for esp-idf project. add tools/ci/python_packages/idf_ci.py for some util functions used in ci and needs multi-os solution
2020-10-21 07:30:49 -04:00
language: python
additional_dependencies:
pre-commit: Use cmakelint 1.4.1 not older commit
2020-11-08 18:06:05 -05:00
- cmakelint==1.4.1
CI: Add pre-commit for esp-idf project. add tools/ci/python_packages/idf_ci.py for some util functions used in ci and needs multi-os solution
2020-10-21 07:30:49 -04:00
files: 'CMakeLists.txt$|\.cmake$'
exclude: '\/third_party\/'
- id: check-codeowners
name: Validate Codeowner File
entry: tools/ci/check_codeowners.py ci-check
language: python
files: '\.gitlab/CODEOWNERS'
pass_filenames: false
ci(pre-commit): check if rules is updated and valid
2021-02-08 23:34:16 -05:00
- id: check-rules-yml
name: Check rules.yml all rules have at lease one job applied, all rules needed exist
entry: tools/ci/check_rules_yml.py
language: python
files: '\.gitlab/ci/.+\.yml|\.gitlab-ci.yml'
pass_filenames: false
additional_dependencies:
- PyYAML == 5.3.1
- id: check-generated-rules
name: Check rules are generated (based on .gitlab/ci/dependencies/dependencies.yml)
entry: .gitlab/ci/dependencies/generate_rules.py
language: python
ci: run c3 unit test when other unit test run C3 unit test were only being ran by unit_test_esp32c3 label/title, should also be trigger by unit_test label/title
2021-03-03 01:28:05 -05:00
files: '\.gitlab/ci/dependencies/.+|\.gitlab/ci/rules\.yml'
ci(pre-commit): check if rules is updated and valid
2021-02-08 23:34:16 -05:00
pass_filenames: false
additional_dependencies:
- PyYAML == 5.3.1
Add mypy check to pre-commit-config
2021-02-01 03:18:16 -05:00
- id: mypy-check
name: Check type annotations in python files
entry: tools/ci/check_type_comments.py
Add copyright check to pre-commit-config
2021-09-08 11:38:14 -04:00
additional_dependencies:
CI: update mypy for pre-commit
2022-05-11 09:20:01 -04:00
- 'mypy==1.0.1'
- 'mypy-extensions==1.0.0'
protobuf: Fix v4.21.0 (python) compatibility issue - Added auto-generated protobuf files (proto-c and python to pre-commit hook ignore lists
2022-05-27 00:05:46 -04:00
exclude: >
(?x)^(
.*_pb2.py
)$
Add mypy check to pre-commit-config
2021-02-01 03:18:16 -05:00
language: python
types: [python]
ci: move check_tools_files_patterns to pre-commit
2021-10-11 22:47:28 -04:00
- id: check-tools-files-patterns
name: Check tools dir files patterns
entry: tools/ci/check_tools_files_patterns.py
language: python
files: '^tools/.+'
additional_dependencies:
- PyYAML == 5.3.1
pass_filenames: false
ci: put file sorter to the end of the pre-commit checking So that the sorter will be done at the end of the checking flow, we don't need to run pre-commit hooks again if another hook also take effect.
2021-04-26 03:58:03 -04:00
- repo: https://github.com/pre-commit/pre-commit-hooks
Add copyright check to pre-commit-config
2021-09-08 11:38:14 -04:00
rev: v4.0.1
ci: put file sorter to the end of the pre-commit checking So that the sorter will be done at the end of the checking flow, we don't need to run pre-commit hooks again if another hook also take effect.
2021-04-26 03:58:03 -04:00
hooks:
- id: file-contents-sorter
CI: Remove the copyright header check from the release branch
2021-11-01 07:31:10 -04:00
files: 'tools\/ci\/(executable-list\.txt|mypy_ignore_list\.txt)'
feat: use esp-idf-sbom pre-commit plugin Currently sbom manifest is checked only in .gitmodules and this check is done in pre-commit and also in CI. Meaning it's running three times(pre-commit before push if user has it enabled, in CI as there is the pre-commit run again and again with test in CI). Since esp-idf-sbom contains a full manifest validation support and pre-commit plugin for it, let's use it. This removes all the current sbom testing and replaces it with a signle pre-commit plugin which validates all manifests files(sbom.yml, idf_component.yml, .gitmodules and also referenced manifests) in repository. Note that this checks all manifests, not only ones which were modified. The check is reasonably fast though, so it should not cause any problem. The reason for validating all manifest files is that we want to make sure that the sbom information in .gitmodules is updated too and that the hash recorded in .gitmodules is up-to-date. Meaning submodule update would not trigger this plugin, because no manifest was changed. Signed-off-by: Frantisek Hrbata <frantisek.hrbata@espressif.com>
2023-12-05 04:06:05 -05:00
- repo: https://github.com/espressif/esp-idf-sbom.git
fix: bump esp-idf-sbom to v0.13.0 in pre-commit v0.13.0 contains fix for the submodule hash validation. Let's bump its version in pre-commit, so the fix is used. Signed-off-by: Frantisek Hrbata <frantisek.hrbata@espressif.com>
2023-12-12 06:26:34 -05:00
rev: v0.13.0
feat: use esp-idf-sbom pre-commit plugin Currently sbom manifest is checked only in .gitmodules and this check is done in pre-commit and also in CI. Meaning it's running three times(pre-commit before push if user has it enabled, in CI as there is the pre-commit run again and again with test in CI). Since esp-idf-sbom contains a full manifest validation support and pre-commit plugin for it, let's use it. This removes all the current sbom testing and replaces it with a signle pre-commit plugin which validates all manifests files(sbom.yml, idf_component.yml, .gitmodules and also referenced manifests) in repository. Note that this checks all manifests, not only ones which were modified. The check is reasonably fast though, so it should not cause any problem. The reason for validating all manifest files is that we want to make sure that the sbom information in .gitmodules is updated too and that the hash recorded in .gitmodules is up-to-date. Meaning submodule update would not trigger this plugin, because no manifest was changed. Signed-off-by: Frantisek Hrbata <frantisek.hrbata@espressif.com>
2023-12-05 04:06:05 -05:00
hooks:
- id: validate-sbom-manifest
fix: do sbom manifest validation in post-commit Following commit c3afbebf2316 ("fix: bump esp-idf-sbom to v0.13.0 in pre-commit"), the validation of submodule hash now relies solely on the information recorded in the git-tree. Previously, the hash verification used submodule's working tree hash if available. Since the new submodule hash is recorded in git-tree only after the commit is created, we need to move the check into post-commit, otherwise the hash validation checks the old value. For example: 1. in .gitmodules [submodule "components/json/cJSON"] sbom-hash = cb8693b058ba302f4829ec6d03f609ac6f848546 2. update the cJSON $ git -C components/json/cJSON checkout b45f48e600671feade0b6bd65d1c69de7899f2be 3. update cJSON hash in .gitmodules [submodule "components/json/cJSON"] sbom-hash = b45f48e600671feade0b6bd65d1c69de7899f2be 4. commit the changes $ git commit -a -s Step 4. will fail, because the validation is currently started in pre-commit stage, where the hash for cJSON recorded in git-tree is still cb8693b058ba302f4829ec6d03f609ac6f848546. The new hash b45f48e600671feade0b6bd65d1c69de7899f2be will be stored in git-tree after the new commit is created. Note that this means we cannot prevent the commit creation, but only notify user about the hash inconsistency. If he/she still decides to push it, it will fail in pre-commit checks in CI. Signed-off-by: Frantisek Hrbata <frantisek.hrbata@espressif.com>
2023-12-18 02:08:13 -05:00
stages: [post-commit]
Reference in New Issue Copy Permalink