Skip to content

Commit

Permalink
Merge pull request #5 from boozt-platform/docs-update-main-readme
Browse files Browse the repository at this point in the history
docs: update main README.md file to add new hook feature
  • Loading branch information
doniz authored Mar 7, 2024
2 parents bd9929c + f2657c1 commit f7d9bfd
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,21 +21,24 @@ Various organizational hooks based on the [lefthook](https://github.com/evilmart
```yaml
remotes:
- git_url: [email protected]:boozt-platform/lefthook
ref: v1.1.1
ref: v1.2.0
configs:
# lint commit messages based by the conventional commits
- hooks/commitlint/.lefthook.yaml
# lint Dockerfiles
- hooks/hadolint/.lefthook.yaml
# lint shell scripts
- hooks/shellcheck/.lefthook.yaml
# check if the license headers are present in the files
- hooks/license-checker/.lefthook.yaml
```
## Available Hooks
- [commitlint](./hooks/commitlint/) (**commit-msg**) - Lint commit messages based by the conventional commits
- [hadolint](./hooks/hadolint/) (**pre-commit**) - A smarter Dockerfile linter
- [shellcheck](./hooks/shellcheck/) (**pre-commit**) - a static analysis tool for shell scripts
- [license-checker](./hooks/license-checker/) (**pre-commit**) - Checks if the license headers are present in the Git staged files with possibility to exclude certain files or file extensions using Regular Expression pattern.
## About Boozt
Expand Down

0 comments on commit f7d9bfd

Please sign in to comment.