golang-cli-template

golang-cli-template

Required Steps

• Single command is mostly enough to prepare project, it will prompt you with some questions about your new project:

  $ make -s prepare-initial-project
  

Additional nice-to-have steps

• If you want to build and publish Docker image:
  • Ensure DOCKER_USERNAME has been added as repository secret on GitHub
  • Ensure DOCKER_PASSWORD has been added as repository secret on GitHub
  • Uncomment line 178 to line 185 in .github/workflows/push.yml
  • Uncomment line 32 to line 50 in build/package/.goreleaser.yaml
• If you want to enable https://sonarcloud.io/ integration:
  • Ensure your created repository from that template has been added to https://sonarcloud.io/
  • Ensure SONAR_TOKEN has been added as repository secret on GitHub
  • Ensure SONAR_TOKEN has been added as dependabot secret on GitHub
  • Uncomment line 149 in .github/workflows/push.yml
  • Uncomment line 94 to line 123 in .github/workflows/push.yml
• If you want to create banner:
  • Generate a banner from here and place it inside of build/ci directory
  • Uncomment line 30 and line 31 in cmd/root.go
  • Run go get -u github.com/dimiro1/banner
• If you want to release as Homebrew Formula:
  • At first, you must have a formula repository like https://github.com/bilalcaliskan/homebrew-tap
  • Ensure TAP_GITHUB_TOKEN has been added as repository secret on GitHub
  • Uncomment line 198 in .github/workflows/push.yml
  • Uncomment line 70 to line 80 in build/package/.goreleaser.yaml

Used Libraries

• spf13/cobra
• stretchr/testify
• go.uber.org/zap

Development

This project requires below tools while developing:

• Golang 1.19
• pre-commit
• golangci-lint - required by pre-commit
• gocyclo - required by pre-commit

After you installed pre-commit, simply run below command to prepare your development environment:

$ pre-commit install -c build/ci/.pre-commit-config.yaml