goyek repository template

⭐ Star this repository if you find it valuable and worth maintaining.

Description

This is a GitHub repository template for a Go application that uses goyek for build automation.

It also includes:

• continuous integration via GitHub Actions,
• dependency management using Go Modules,
• code formatting using gofumpt,
• linting with golangci-lint,
• spell checking using misspell,
• unit testing with race detector, code covarage HTML report and Codecov report,
• dependencies scanning and updating thanks to Dependabot,
• security code analysis using CodeQL Action,
• Visual Studio Code configuration with Go support.

Usage

1. Sign up on Codecov and configure Codecov GitHub Application for all repositories.
2. Click the Use this template button (alt. clone, fork or download this repository).
3. Replace all occurrences of goyek/template to your_org/repo_name in all files.
4. Update the following files:
   • CODE_OF_CONDUCT.md
   • LICENSE
   • README.md

Setup

Below you can find sample instructions on how to set up the development environment. Of course, you can use other tools like GoLand, Vim, Emacs. However, take notice that the Visual Studio Go extension is officially supported by the Go team.

1. Install Go.
2. Install Visual Studio Code.
3. Install Go extension.
4. Clone and open this repository.
5. F1 -> Go: Install/Update Tools -> (select all) -> OK.

Build

cd build
go run .

Using convenient Bash script:

./goyek.sh

Using convenient PowerShell script:

.\goyek.ps1

Using Visual Studio Code:

F1 → Tasks: Run Build Task (Ctrl+Shift+B or ⇧⌘B)

Maintenance

Notable files:

• .github/workflows - GitHub Actions workflows,
• .github/dependabot.yml - Dependabot configuration,
• .vscode - Visual Studio Code configuration files,
• build - build pipeline used for local development, CI build, and .vscode/tasks.json,
• build/tools.go - build tools,
• .golangci.yml - golangci-lint configuration.