generated from boozt-platform/quickstart-template
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #5 from boozt-platform/docs-update-main-readme
docs: update main README.md file to add new hook feature
- Loading branch information
Showing
1 changed file
with
4 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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 | ||
|