damianoneill / cookiecutter-golang

golang cookiecutter

cookiecutter-golang

Powered by Cookiecutter

Features

• Generates
  • Makefile -- can be used to add project specific targets or to override/extend common targets
    • golang.mk -- contains common go targets
  • go.mod
  • tools.go -- contains go tools used by this project, can be generated using make tools.
  • cobra/viper based mainline
    • cobra completion command
    • cobra version command
  • gitlab-ci config

See below for the available targets of the makefile

$ make help

Usage:
  make <target> ignore suffix -default e.g. make install

Targets:
  all-default           run the mod, generate, fmt, test, lint and install targets
  clean-default         remove project artifacts e.g. tools directory
  install-default       install the binary
  build-default         build the binary, ignoring vendored code if it exists
  test-default          run test with coverage
  coverage-default      report on test coverage
  fmt-default           format the code
  mod-default           makes sure go.mod matches the source code in the module
  archive-default       archive the third party dependencies, typically prior to generating a tagged release
  lint-default          run golangci-lint using the configuration in .golangci.yml
  generate-default      go generate code
  tools-default         install the project specific tools into $GOBIN
  image-default         build the docker image
  licenses-default      print list of licenses for third party software used in binary
  add-license-default   add copyright license headers to go source code
  security-default      run go security check
  outdated-default      check for outdated direct dependencies
  lines-default         shorten lines longer than 100 chars, ignore generated
  authors-default       update the AUTHORS file
  changelog-default     update the CHANGELOG.md

Assumptions

• Generated project will be configuration managed by git
• Assumes you have docker installed / configured

Usage

$ brew install cookiecutter

Or

$ pip install cookiecutter

Then

$ cookiecutter https://github.com/damianoneill/cookiecutter-golang.git