mirror/godot
2
0
Fork 0
mirror of https://github.com/godotengine/godot.git synced 2024-11-21 03:18:37 +08:00
Code Issues Packages Projects Releases Wiki Activity
2be730a05b
godot/.pre-commit-config.yaml

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

199 lines
6.2 KiB
YAML
Raw Normal View History

CI: Make local python hooks multi-platform
2024-06-03 02:22:34 +08:00
default_language_version:
python: python3
CI: Overhaul static checks to use `pre-commit`
2024-05-02 05:02:35 +08:00
exclude: |
(?x)^(
.*thirdparty/.*|
.*-so_wrap\.(h|c)$
)
Replace hand-written pre-commit hooks with `pre-commit` Python tool `pre-commit` can be installed with pip, and configured in the Godot repo with `pre-commit install`. It can then easily be run both locally with `pre-commit run`, and on CI, in a cross-platform way. This makes it much easier for contributors to set up pre-commit hooks, without having to manually copy files to their git folder. Co-authored-by: Rémi Verschelde <rverschelde@gmail.com>
2024-01-09 20:47:16 +08:00
repos:
- repo: https://github.com/pre-commit/mirrors-clang-format
CI: Update pre-commit `clang-format` to 18.1.8 • Modernized `.clang-format` file against latest LLVM config settings
2024-06-18 23:36:58 +08:00
rev: v18.1.8
Replace hand-written pre-commit hooks with `pre-commit` Python tool `pre-commit` can be installed with pip, and configured in the Godot repo with `pre-commit install`. It can then easily be run both locally with `pre-commit run`, and on CI, in a cross-platform way. This makes it much easier for contributors to set up pre-commit hooks, without having to manually copy files to their git folder. Co-authored-by: Rémi Verschelde <rverschelde@gmail.com>
2024-01-09 20:47:16 +08:00
hooks:
- id: clang-format
CI: Make local python hooks multi-platform
2024-06-03 02:22:34 +08:00
files: \.(c|h|cpp|hpp|cc|hh|cxx|hxx|m|mm|inc|java|glsl)$
Replace hand-written pre-commit hooks with `pre-commit` Python tool `pre-commit` can be installed with pip, and configured in the Godot repo with `pre-commit install`. It can then easily be run both locally with `pre-commit run`, and on CI, in a cross-platform way. This makes it much easier for contributors to set up pre-commit hooks, without having to manually copy files to their git folder. Co-authored-by: Rémi Verschelde <rverschelde@gmail.com>
2024-01-09 20:47:16 +08:00
types_or: [text]
exclude: |
(?x)^(
CI: Overhaul static checks to use `pre-commit`
2024-05-02 05:02:35 +08:00
tests/python_build/.*|
Add support to the Android editor for signing and verifying Android apks - Apk signing and verification is enabled using the apksig library from https://android.googlesource.com/platform/tools/apksig/+/ac5cbb07d87cc342fcf07715857a812305d69888
2024-08-27 02:12:50 +08:00
platform/android/java/editor/src/main/java/com/android/.*|
CI: Overhaul static checks to use `pre-commit`
2024-05-02 05:02:35 +08:00
platform/android/java/lib/src/com/.*
Replace hand-written pre-commit hooks with `pre-commit` Python tool `pre-commit` can be installed with pip, and configured in the Godot repo with `pre-commit install`. It can then easily be run both locally with `pre-commit run`, and on CI, in a cross-platform way. This makes it much easier for contributors to set up pre-commit hooks, without having to manually copy files to their git folder. Co-authored-by: Rémi Verschelde <rverschelde@gmail.com>
2024-01-09 20:47:16 +08:00
)
CI: Add pre-commit hook for `clang-tidy` • Set to "manual" so it isn't invoked in normal workflow • Modernize `.clang-tidy` file
2024-06-17 23:39:02 +08:00
- repo: https://github.com/pocc/pre-commit-hooks
rev: v1.3.5
hooks:
- id: clang-tidy
files: \.(c|h|cpp|hpp|cc|hh|cxx|hxx|m|mm|inc|java|glsl)$
args: [--fix, --quiet, --use-color]
types_or: [text]
exclude: |
(?x)^(
tests/python_build/.*|
Add support to the Android editor for signing and verifying Android apks - Apk signing and verification is enabled using the apksig library from https://android.googlesource.com/platform/tools/apksig/+/ac5cbb07d87cc342fcf07715857a812305d69888
2024-08-27 02:12:50 +08:00
platform/android/java/editor/src/main/java/com/android/.*|
CI: Add pre-commit hook for `clang-tidy` • Set to "manual" so it isn't invoked in normal workflow • Modernize `.clang-tidy` file
2024-06-17 23:39:02 +08:00
platform/android/java/lib/src/com/.*
)
additional_dependencies: [clang-tidy==18.1.1]
require_serial: true
stages: [manual] # Not automatically triggered, invoked via `pre-commit run --hook-stage manual clang-tidy`
Update pre-commit hooks configuration to use `ruff` instead of `black`
2024-05-21 21:14:59 +08:00
- repo: https://github.com/astral-sh/ruff-pre-commit
rev: v0.4.4
Replace hand-written pre-commit hooks with `pre-commit` Python tool `pre-commit` can be installed with pip, and configured in the Godot repo with `pre-commit install`. It can then easily be run both locally with `pre-commit run`, and on CI, in a cross-platform way. This makes it much easier for contributors to set up pre-commit hooks, without having to manually copy files to their git folder. Co-authored-by: Rémi Verschelde <rverschelde@gmail.com>
2024-01-09 20:47:16 +08:00
hooks:
Update pre-commit hooks configuration to use `ruff` instead of `black`
2024-05-21 21:14:59 +08:00
- id: ruff
args: [--fix]
- id: ruff-format
Replace hand-written pre-commit hooks with `pre-commit` Python tool `pre-commit` can be installed with pip, and configured in the Godot repo with `pre-commit install`. It can then easily be run both locally with `pre-commit run`, and on CI, in a cross-platform way. This makes it much easier for contributors to set up pre-commit hooks, without having to manually copy files to their git folder. Co-authored-by: Rémi Verschelde <rverschelde@gmail.com>
2024-01-09 20:47:16 +08:00
CI: Overhaul static checks to use `pre-commit`
2024-05-02 05:02:35 +08:00
- repo: https://github.com/pre-commit/mirrors-mypy
rev: v0.971
hooks:
- id: mypy
files: \.py$
types_or: [text]
- repo: https://github.com/codespell-project/codespell
CI: Migrate codespell logic to `pyproject.toml`
2024-06-03 23:19:58 +08:00
rev: v2.3.0
CI: Overhaul static checks to use `pre-commit`
2024-05-02 05:02:35 +08:00
hooks:
- id: codespell
Add support to the Android editor for signing and verifying Android apks - Apk signing and verification is enabled using the apksig library from https://android.googlesource.com/platform/tools/apksig/+/ac5cbb07d87cc342fcf07715857a812305d69888
2024-08-27 02:12:50 +08:00
exclude: |
(?x)^(
platform/android/java/editor/src/main/java/com/android/.*|
platform/android/java/lib/src/com/.*
)
CI: Migrate codespell logic to `pyproject.toml`
2024-06-03 23:19:58 +08:00
additional_dependencies: [tomli]
CI: Overhaul static checks to use `pre-commit`
2024-05-02 05:02:35 +08:00
### Requires Docker; look into alternative implementation.
# - repo: https://github.com/comkieffer/pre-commit-xmllint.git
# rev: 1.0.0
# hooks:
# - id: xmllint
# language: docker
# types_or: [text]
# files: ^(doc/classes|.*/doc_classes)/.*\.xml$
# args: [--schema, doc/class.xsd]
Replace hand-written pre-commit hooks with `pre-commit` Python tool `pre-commit` can be installed with pip, and configured in the Godot repo with `pre-commit install`. It can then easily be run both locally with `pre-commit run`, and on CI, in a cross-platform way. This makes it much easier for contributors to set up pre-commit hooks, without having to manually copy files to their git folder. Co-authored-by: Rémi Verschelde <rverschelde@gmail.com>
2024-01-09 20:47:16 +08:00
- repo: local
hooks:
- id: make-rst
name: make-rst
CI: Overhaul static checks to use `pre-commit`
2024-05-02 05:02:35 +08:00
language: python
CI: Make local python hooks multi-platform
2024-06-03 02:22:34 +08:00
entry: python doc/tools/make_rst.py
args: [doc/classes, modules, platform, --dry-run, --color]
Replace hand-written pre-commit hooks with `pre-commit` Python tool `pre-commit` can be installed with pip, and configured in the Godot repo with `pre-commit install`. It can then easily be run both locally with `pre-commit run`, and on CI, in a cross-platform way. This makes it much easier for contributors to set up pre-commit hooks, without having to manually copy files to their git folder. Co-authored-by: Rémi Verschelde <rverschelde@gmail.com>
2024-01-09 20:47:16 +08:00
pass_filenames: false
CI: Overhaul static checks to use `pre-commit`
2024-05-02 05:02:35 +08:00
files: ^(doc/classes|.*/doc_classes)/.*\.xml$
- id: doc-status
name: doc-status
Replace hand-written pre-commit hooks with `pre-commit` Python tool `pre-commit` can be installed with pip, and configured in the Godot repo with `pre-commit install`. It can then easily be run both locally with `pre-commit run`, and on CI, in a cross-platform way. This makes it much easier for contributors to set up pre-commit hooks, without having to manually copy files to their git folder. Co-authored-by: Rémi Verschelde <rverschelde@gmail.com>
2024-01-09 20:47:16 +08:00
language: python
CI: Make local python hooks multi-platform
2024-06-03 02:22:34 +08:00
entry: python doc/tools/doc_status.py
args: [doc/classes, modules/*/doc_classes, platform/*/doc_classes]
pass_filenames: false
CI: Overhaul static checks to use `pre-commit`
2024-05-02 05:02:35 +08:00
files: ^(doc/classes|.*/doc_classes)/.*\.xml$
Upgrade to eslint 9
2024-05-12 10:16:02 +08:00
- id: eslint
name: eslint
language: node
entry: eslint
files: ^(platform/web/js/|modules/|misc/dist/html/).*\.(js|html)$
Style: Format yaml files
2024-07-08 23:41:20 +08:00
args:
Fix eslint .pre-commit-config.yaml by removing commas
2024-09-16 23:03:08 +08:00
- --fix
- --no-warn-ignored
- --no-config-lookup
- --config
- platform/web/eslint.config.cjs
Upgrade to eslint 9
2024-05-12 10:16:02 +08:00
additional_dependencies:
- '@eslint/js@^9.3.0'
- '@html-eslint/eslint-plugin@^0.24.1'
- '@html-eslint/parser@^0.24.1'
- '@stylistic/eslint-plugin@^2.1.0'
Style: Format yaml files
2024-07-08 23:41:20 +08:00
- eslint@^9.3.0
- eslint-plugin-html@^8.1.1
- globals@^15.3.0
- espree@^10.0.1
Upgrade to eslint 9
2024-05-12 10:16:02 +08:00
CI: Overhaul static checks to use `pre-commit`
2024-05-02 05:02:35 +08:00
- id: jsdoc
name: jsdoc
language: node
entry: jsdoc
files: ^platform/web/js/engine/(engine|config|features)\.js$
Fix for jsdoc hook in pre-commit
2024-05-16 19:50:13 +08:00
args:
- --template
- platform/web/js/jsdoc2rst/
- platform/web/js/engine/engine.js
- platform/web/js/engine/config.js
- platform/web/js/engine/features.js
- --destination
- ''
- -d
- dry-run
pass_filenames: false
Style: Format yaml files
2024-07-08 23:41:20 +08:00
additional_dependencies: [jsdoc@^4.0.3]
Replace hand-written pre-commit hooks with `pre-commit` Python tool `pre-commit` can be installed with pip, and configured in the Godot repo with `pre-commit install`. It can then easily be run both locally with `pre-commit run`, and on CI, in a cross-platform way. This makes it much easier for contributors to set up pre-commit hooks, without having to manually copy files to their git folder. Co-authored-by: Rémi Verschelde <rverschelde@gmail.com>
2024-01-09 20:47:16 +08:00
CI: Add `svgo` pre-commit hook
2024-06-04 22:49:56 +08:00
- id: svgo
name: svgo
language: node
entry: svgo
files: \.svg$
args: [--quiet, --config, misc/utility/svgo.config.mjs]
Style: Format yaml files
2024-07-08 23:41:20 +08:00
additional_dependencies: [svgo@3.3.2]
CI: Add `svgo` pre-commit hook
2024-06-04 22:49:56 +08:00
Replace hand-written pre-commit hooks with `pre-commit` Python tool `pre-commit` can be installed with pip, and configured in the Godot repo with `pre-commit install`. It can then easily be run both locally with `pre-commit run`, and on CI, in a cross-platform way. This makes it much easier for contributors to set up pre-commit hooks, without having to manually copy files to their git folder. Co-authored-by: Rémi Verschelde <rverschelde@gmail.com>
2024-01-09 20:47:16 +08:00
- id: copyright-headers
name: copyright-headers
language: python
CI: Make local python hooks multi-platform
2024-06-03 02:22:34 +08:00
entry: python misc/scripts/copyright_headers.py
files: \.(c|h|cpp|hpp|cc|hh|cxx|hxx|m|mm|inc|java)$
Replace hand-written pre-commit hooks with `pre-commit` Python tool `pre-commit` can be installed with pip, and configured in the Godot repo with `pre-commit install`. It can then easily be run both locally with `pre-commit run`, and on CI, in a cross-platform way. This makes it much easier for contributors to set up pre-commit hooks, without having to manually copy files to their git folder. Co-authored-by: Rémi Verschelde <rverschelde@gmail.com>
2024-01-09 20:47:16 +08:00
exclude: |
(?x)^(
Pre-commit: Fix `copyright_headers.py` to run on all relevant files It was only running on the first file passed by pre-commit, instead of all. Fixes compatibility with Windows paths to get the basename.
2024-03-12 22:07:09 +08:00
core/math/bvh_.*\.inc$|
Pre-commit: Allow adding downstream hooks without (less) risk of conflicts Apply Godot copyright header only on the platform folders that we maintain upstream. This lets downstream forks decide what to do with their potential proprietary platforms.
2024-05-21 21:58:47 +08:00
platform/(?!android|ios|linuxbsd|macos|web|windows)\w+/.*|
Add support to the Android editor for signing and verifying Android apks - Apk signing and verification is enabled using the apksig library from https://android.googlesource.com/platform/tools/apksig/+/ac5cbb07d87cc342fcf07715857a812305d69888
2024-08-27 02:12:50 +08:00
platform/android/java/editor/src/main/java/com/android/.*|
CI: Overhaul static checks to use `pre-commit`
2024-05-02 05:02:35 +08:00
platform/android/java/lib/src/com/.*|
platform/android/java/lib/src/org/godotengine/godot/gl/GLSurfaceView\.java$|
platform/android/java/lib/src/org/godotengine/godot/gl/EGLLogWrapper\.java$|
platform/android/java/lib/src/org/godotengine/godot/utils/ProcessPhoenix\.java$
)
- id: header-guards
name: header-guards
language: python
CI: Make local python hooks multi-platform
2024-06-03 02:22:34 +08:00
entry: python misc/scripts/header_guards.py
files: \.(h|hpp|hh|hxx)$
exclude: ^.*/(thread|platform_config|platform_gl)\.h$
CI: Overhaul static checks to use `pre-commit`
2024-05-02 05:02:35 +08:00
- id: file-format
name: file-format
language: python
CI: Make local python hooks multi-platform
2024-06-03 02:22:34 +08:00
entry: python misc/scripts/file_format.py
CI: Overhaul static checks to use `pre-commit`
2024-05-02 05:02:35 +08:00
types_or: [text]
exclude: |
(?x)^(
.*\.test\.txt$|
.*\.svg$|
.*\.patch$|
.*\.out$|
modules/gdscript/tests/scripts/parser/features/mixed_indentation_on_blank_lines\.gd$|
modules/gdscript/tests/scripts/parser/warnings/empty_file_newline_comment\.notest\.gd$|
modules/gdscript/tests/scripts/parser/warnings/empty_file_newline\.notest\.gd$|
Update the `GodotHost` interface to support signing and verifying Android apks Update the export logic to enable apk generation and signing for Android editor builds Note: Only legacy builds are supported. Gradle builds are not supported at this point in time.
2024-06-17 03:14:34 +08:00
platform/android/java/editor/src/main/java/com/android/.*|
CI: Overhaul static checks to use `pre-commit`
2024-05-02 05:02:35 +08:00
platform/android/java/lib/src/com/google/.*
Replace hand-written pre-commit hooks with `pre-commit` Python tool `pre-commit` can be installed with pip, and configured in the Godot repo with `pre-commit install`. It can then easily be run both locally with `pre-commit run`, and on CI, in a cross-platform way. This makes it much easier for contributors to set up pre-commit hooks, without having to manually copy files to their git folder. Co-authored-by: Rémi Verschelde <rverschelde@gmail.com>
2024-01-09 20:47:16 +08:00
)
Move dotnet-format script to pre-commit Co-authored-by: Paul Joannon <437025+paulloz@users.noreply.github.com>
2024-02-28 04:09:04 +08:00
- id: dotnet-format
name: dotnet-format
language: python
CI: Make local python hooks multi-platform
2024-06-03 02:22:34 +08:00
entry: python misc/scripts/dotnet_format.py
Move dotnet-format script to pre-commit Co-authored-by: Paul Joannon <437025+paulloz@users.noreply.github.com>
2024-02-28 04:09:04 +08:00
types_or: [c#]
Style: Format yaml files
2024-07-08 23:41:20 +08:00
#
Pre-commit: Allow adding downstream hooks without (less) risk of conflicts Apply Godot copyright header only on the platform folders that we maintain upstream. This lets downstream forks decide what to do with their potential proprietary platforms.
2024-05-21 21:58:47 +08:00
# End of upstream Godot pre-commit hooks.
#
# Keep this separation to let downstream forks add their own hooks to this file,
# without running into merge conflicts when rebasing on latest upstream.
#
# Start of downstream pre-commit hooks.
#
# This is still the "repo: local" scope, so new local hooks can be defined directly at this indentation:
# - id: new-local-hook
# To add external repo hooks, bring the indentation back to:
# - repo: my-remote-hook
Reference in New Issue Copy Permalink