swellaby / captain-githook Goto Github PK

View Code? Open in Web Editor NEW

30.0 3.0 2.0 279 KB

git hook utility for Go codebases

License: MIT License

Go 99.77% Shell 0.23%

go golang git githook githooks-plugin hooks hook-manager git-hooks

captain-githook's Introduction

captain-githook

Cross-platform, configurable, git hook utility geared for Go codebases.

****** Functional, but still in Beta ******

About
Installation
Getting Started
Configure
- Supported Git Hooks
- Allowed Config File Names
Remove

About

Git hooks are scripts/commands that git can execute on certain events which helps you automate tasks, enforce quality and consistency in your code, and more. captain-githook allows you to utilize any and all git hooks in your repository (commit-msg, pre-commit, pre-push, etc.) via a simple configuration file.

Yes, there are other git hook utilities out there (in fact we love, recommend, and use husky in our JavaScript/TypeScript projects that use npm). However, we made captain-githook because we wanted a git hook utility for our Go codebases that was cross-platform, easily configurable, and that wasn't dependent on another, non-Go framework/runtime.

Installation

We'll be adding binary releases shortly, but for now you'll need to have your Go environment setup and use go get i.e.:

go get -u github.com/swellaby/captain-githook

Note that the latest captain-githook version requires Go 1.12 or higher. If you need to use captain-githook on Go 1.11 and earlier, make sure you use the v0.0.7 tag:

go get -u github.com/swellaby/[email protected]

This will ensure that the captain-githook executable is available on your system for initializing your repositories (creating git hook and config files) as well as for executing your defined hook scripts.

Getting Started

Run the init sub-command within a git repository to create the git hook files and create the captain-githook config file:

captain-githook init

If you'd prefer to use a different name for the config file, you can specify your desired config file name as a flag (--config-filename or --f) on the init command. For example:

captain-githook init --config-filename .captain-githookrc.json

See allowed config file names below for info on what config file names you can use.

Configure

You specify which scripts/commands you want to run for each git hook in the captain-githook configuration file included in your repository.

The captain-githook config is a json formatted file (we'll consider supporting other formats like yaml or toml if there's enough interest) and must be named with one of the allowed file names.

Just ensure there's a hooks object key, and then for every git hook you want to run, add a key with the hook name (see supported hooks for allowed hook names) and the script/command you want to run.

// captaingithook.json
{
    "hooks": {
        "pre-commit": "golint ./...",
        "pre-push": "go test ./..."
    }
}

Supported Hooks

captain-githook supports all the below git hooks:

applypatch-msg
pre-applypatch
post-applypatch
pre-commit
prepare-commit-msg
commit-msg
post-commit
pre-rebase
post-checkout
post-merge
pre-receive
update
post-receive
post-update
pre-auto-gc
post-rewrite
pre-push

Config File Names

There are several supported names you can use for your config file:

captaingithook.json
.captaingithook.json
captaingithookrc
.captaingithookrc
captaingithookrc.json
.captaingithookrc.json
captain-githook.json
.captain-githook.json
captain-githookrc
.captain-githookrc
captain-githookrc.json
.captain-githookrc.json

Remove

Not yet implemented

captain-githook's People

Contributors

Stargazers

Watchers

Forkers

scalerstech zhaohao19941221

captain-githook's Issues

Add Goreleaser

Incorporate Goreleaser to simplify and facilitate the compilation/packaging/etc. process of the release artifacts

Tag current version before dropping Go 1.11 Support

Switch to Testify for assertions

Should help reduce the size of the test files and make them more succinct/readable

Release Pipeline

Need to setup a release pipeline to build various platform binaries, validate, and publish them to GitHub releases

Support skipping hook installs

We should add support for skipping the installation of hooks, as this is very helpful in many circumstances and also a commonly supported feature in other git hook utils.

Add removal functionality

Implement functionality to remove hook files from repo

Consider Githooks

Hi Devs,

Consider contributing to https://github.com/gabyx/githooks. Disclaimer it was orginally not written by me but ported and rewritten to Go by me.
Contribution is highly welcome as it could get more aswesome etc.

Switch to Task

Switch from Mage to Task now that we know about gotestsum.

While Mage is a decent solution for running tasks in Go projects, we were only using it here due to our need to generate multiple test result format files (for Sonar, Azure DevOps, etc.) which needs to be done programmatically. gotestsum however provides a great CLI for handling all that work which means we no longer need our own Go code using exec.Command from the os package.

Task allows us to utilize a configuration file (yaml) to define scripts, much like npm scripts defined in the package.json file, and allows to avoid some of the challenges mage creates with *-on-save features and placing *.go source files in the root of the repo.