system/serenity
system/serenity
1
0
Fork 0
mirror of https://github.com/SerenityOS/serenity synced 2024-07-05 21:14:49 +00:00
Code Issues Projects Releases Wiki Activity
225108c830
serenity/.pre-commit-config.yaml

24 lines
710 B
YAML
Raw Normal View History

Meta: Add .pre-commit-config.yaml This pre-commit config is quite simple: all it does for now is running the already existing Meta/lint-ci.sh script to ensure no changes that won't pass the CI linting step are committed. Consequently pass_filenames is set to false, as these scripts will determine which files to check themselves - should this ever become a performance bottleneck, we can update them to accept an optional list of filenames. It should be noted that using pre-commit for Serenity development is by no means a requirement, but doing so may decrease the number of CI builds failing due to forgotten license headers etc. - especially if you're pushing to `master` directly, rather than going through pull requests *hint hint*. For info how to install & use pre-commit, see https://pre-commit.com/. Fixes #2365.
2020-12-09 18:01:06 +00:00
repos:
- repo: local
hooks:
- id: meta-lint-ci
name: Running Meta/lint-ci.sh to ensure changes will pass linting on CI
entry: bash Meta/lint-ci.sh
Meta: pre-commit should run lint-ports.py only when Ports change Most of the existing lint-ing shell scripts have the ability to only run on the files which have actually changed. The new port lint-ing script doesn't have this functionality unfortunately. This forces us to lint ALL the ports on every single change to any other file in the system if you have the pre-commit hook setup for your git clone locally. Instead we can use pre-commit's feature to only run a hook if certain files have changed to reduce the situations in which we would run the Meta/lint-ports.py script.
2021-04-30 11:30:04 +00:00
args: [ --no-ports ]
Meta: Add a post-commit commit message linter hook This should help with getting commit messages tidy before they pass through CI's commit linter :^) For this hook to work pre-commit has to be explicitly installed via: `pre-commit install --hook-type commit-msg`
2021-05-02 11:16:21 +00:00
stages: [ commit ]
Meta: pre-commit should run lint-ports.py only when Ports change Most of the existing lint-ing shell scripts have the ability to only run on the files which have actually changed. The new port lint-ing script doesn't have this functionality unfortunately. This forces us to lint ALL the ports on every single change to any other file in the system if you have the pre-commit hook setup for your git clone locally. Instead we can use pre-commit's feature to only run a hook if certain files have changed to reduce the situations in which we would run the Meta/lint-ports.py script.
2021-04-30 11:30:04 +00:00
language: system
- id: meta-lint-ports
name: Running Meta/lint-ports.py to ensure changes will pass linting on CI
entry: Meta/lint-ports.py
pass_filenames: false
files: ^Ports/
Meta: Add a post-commit commit message linter hook This should help with getting commit messages tidy before they pass through CI's commit linter :^) For this hook to work pre-commit has to be explicitly installed via: `pre-commit install --hook-type commit-msg`
2021-05-02 11:16:21 +00:00
stages: [ commit ]
language: system
- id: meta-lint-commit
name: Lint commit message to ensure it will pass the commit linting on CI
entry: Meta/lint-commit.sh
stages: [ commit-msg ]
Meta: Add .pre-commit-config.yaml This pre-commit config is quite simple: all it does for now is running the already existing Meta/lint-ci.sh script to ensure no changes that won't pass the CI linting step are committed. Consequently pass_filenames is set to false, as these scripts will determine which files to check themselves - should this ever become a performance bottleneck, we can update them to accept an optional list of filenames. It should be noted that using pre-commit for Serenity development is by no means a requirement, but doing so may decrease the number of CI builds failing due to forgotten license headers etc. - especially if you're pushing to `master` directly, rather than going through pull requests *hint hint*. For info how to install & use pre-commit, see https://pre-commit.com/. Fixes #2365.
2020-12-09 18:01:06 +00:00
language: system
Reference in New Issue Copy Permalink