husky

README

Husky

Make githooks easy!

Inspired from the husky.js

---

Docs

Installation

go install github.com/automation-co/husky@latest

Getting Started

Warning: All husky commands are potentially destructive, they will delete all files in .git/hooks and recreate them from .husky/hooks. If you already have custom hooks in .git/hooks, make sure to create a backup of the hooks before starting to use husky.

You can initialise husky by $ husky init

Make sure you have git initialised

This will make the .husky folder with the hooks folder and a sample pre-commit hook

You can add hooks using

$ husky add <hook> "
  <your commands for that hook>
"

Example

$ husky add pre-commit "
  go build -v ./... 
  go test -v ./...
"

If you have made any other changes in the hooks you can apply them by using $ husky install

---

Blogs and Resources

• Get Started with Husky for go
• Git Hooks for your Golang project

---

Get Familiar with Git Hooks

Learn more about git hooks from these useful resources:

• Customizing Git - Git Hooks
• Atlassian Blog on Git Hooks
• Fei's Blog | Get Started with Git Hooks

---

Other Alternatives

If you feel husky does not fulfill your needs you can also check out:

• https://github.com/typicode/husky
• https://pre-commit.com/

---

Developed by @automation-co