falcosuessgott / golang-cli-template Goto Github PK

View Code? Open in Web Editor NEW

52.0 2.0 10.0 213 KB

A general purpose golang CLI template for Github and Gitlab

Home Page: https://falcosuessgott.github.io/golang-cli-template/

License: MIT License

Makefile 3.56% Go 21.68% Shell 74.01% Dockerfile 0.30% JavaScript 0.45%

go golang template github gitlab

golang-cli-template's Introduction

golang-cli-template

A general purpose project template for golang CLI applications

This template serves as a starting point for golang commandline applications it is based on golang projects that I consider high quality and various other useful blog posts that helped me understanding golang better.

golang-cli-template
Features
Project Layout
How to use this template
Demo Application
Makefile Targets
Contribute

Features

goreleaser with deb. and .rpm packer and container (docker.hub and ghcr.io) releasing including manpages and shell completions and grouped Changelog generation.
golangci-lint for linting and formatting
Github Actions Stages (Lint, Test (windows, linux, mac-os), Build, Release)
Gitlab CI Configuration (Lint, Test, Build, Release)
cobra example setup including tests
Makefile - with various useful targets and documentation (see Makefile Targets)
Github Pages using jekyll-theme-minimal (checkout https://falcosuessgott.github.io/golang-cli-template/)
Useful README.md badges
pre-commit-hooks for formatting and validating code before committing

Project Layout

assets/ => docs, images, etc
cmd/ => commandline configurartions (flags, subcommands)
pkg/ => packages that are okay to import for other projects
internal/ => packages that are only for project internal purposes

tools/ => for automatically shipping all required dependencies when running go get (or make bootstrap) such as golang-ci-lint (see: https://github.com/golang/go/wiki/Modules#how-can-i-track-tool-dependencies-for-a-module) )
scripts/ => build scripts

How to use this template

bash <(curl -s https://raw.githubusercontent.com/FalcoSuessgott/golang-cli-template/master/install.sh)

In order to make the CI work you will need to have the following Secrets in your repository defined:

Repository -> Settings -> Secrets & variables -> CODECOV_TOKEN, DOCKERHUB_TOKEN & DOCKERHUB_USERNAME

Demo Application

$> golang-cli-template -h
golang-cli project template demo application

Usage:
  golang-cli-template [flags]
  golang-cli-template [command]

Available Commands:
  completion  Generate the autocompletion script for the specified shell
  example     example subcommand which adds or multiplies two given integers
  help        Help about any command
  version     golang-cli-template version

Flags:
  -h, --help   help for golang-cli-template

Use "golang-cli-template [command] --help" for more information about a command.

$> golang-cli-template example 2 5 --add
7

$> golang-cli-template example 2 5 --multiply
10

Makefile Targets

$> make
bootstrap                      install build deps
build                          build golang binary
clean                          clean up environment
cover                          display test coverage
docker-build                   dockerize golang application
fmt                            format go files
help                           list makefile targets
install                        install golang binary
lint                           lint go files
pre-commit                     run pre-commit hooks
run                            run the app
test                           display test coverage

Contribute

If you find issues in that setup or have some nice features / improvements, I would welcome an issue or a PR :)

golang-cli-template's People

Contributors

Stargazers

Watchers

Forkers

simonbaeumer yasir2000 yuyuvn mingnyaming trendingtechnology dougefresh reshef-axiom niiku ahlfors malston

golang-cli-template's Issues

add replacements to nfpm

replacements:
      darwin: Darwin
      linux: Linux
      amd64: x86_64

and add example for downloading this

improvements #2

add go get init and go get -u to install script
add install deps script for pre-commit, gofumpt, ....

use github/super-linter

Todo

use table pattern unit testing

add semantic releaser

`make build` returns `fatal: No names found, cannot describe anything.`

As git describe --abbrev=0 --tags fails.

Install on macOS fails with system `sed`

The system version of macOS sed behaves slightly different than Linux.

install.sh fails on macOS (12 - Monterey, but probably earlier and later too) with the following error:

sed: 1: "./cmd/version.go": invalid command code .

This works fine on Linux (or on macOS with non-system sed version) :

find . -type f -exec sed -i "s/golang-cli-template/$projectname/g" {} +
find . -type f -exec sed -i "s/FalcoSuessgott/$user/g" {} +

sed in-place replacement works slightly different on macOS: it wants an empty argument.

find . -type f -exec sed -I "" "s/golang-cli-template/$projectname/g" {} +
find . -type f -exec sed -I "" "s/FalcoSuessgott/$user/g" {} +

Annoying, I know.

I might get around to send a PR for this, but in case I don't here's an issue at least :-)

p.s. thank you for the project!

use go test matrix testing

todos

dockerfile with golang binary
docker build and publish ci stage (gitlab & github)
improve usage script steps
makefile targets documentation

fix docker build and push ci

add mkdocs

The automated release is failing 🚨

🚨 The automated release from the `master` branch failed. 🚨

I recommend you give this issue a high priority, so other packages depending on you can benefit from your bug fixes and new features again.

You can find below the list of errors reported by semantic-release. Each one of them has to be resolved in order to automatically publish your package. I’m sure you can fix this 💪.

Errors are usually caused by a misconfiguration or an authentication problem. With each error reported below you will find explanation and guidance to help you to resolve it.

Once all the errors are resolved, semantic-release will release your package the next time you push a commit to the master branch. You can also manually restart the failed CI job that runs semantic-release.

If you are not sure how to resolve this, here are some links that can help you:

If those don’t help, or if this issue is reporting something you think isn’t right, you can always ask the humans behind semantic-release.

Missing `package.json` file.

A package.json file at the root of your project is required to release on npm.

Please follow the npm guideline to create a valid package.json file.

Good luck with your project ✨

Your semantic-release bot 📦🚀

Add tools file for code dependencies

github pages example

https://pages-themes.github.io/minimal/