README.md

pre-commit-gitops

pre-commit-gitops is a pre-commit component, which wrapper shellcheck to check shell scripts:)

Table of Contents

• Requirements
• Install
• Contributing
• License
• Author

Requirements

pre-commit-shell requires the following to run:

• pre-commit
• branching
• msg

Install

1. create .pre-commit-config.yaml in you git project
2. pre-commit install
3. enjoy it

example .pre-commit-config.yaml as following:

repos:
  - repo: https://github.com/songhanpoo/pre-commit-shell-gitops.git
    rev: v1.0.3
    hooks:
    - id: msg-check
      verbose: false
      args:
        - -p=".*"
    - id: branching-check
      verbose: false
      args:
        - -p=".*"

Contributing

To contribute to pre-commit-gitops, clone this repo locally and commit your code on a separate branch.

Author

GitHub @songhanpoo

License

pre-commit-gitops is licensed under the [MIT] license.