go-template

Robust starter template for a new Go library

Table of Contents

• About
• Installation
• Documentation
• Examples & Tests
• Benchmarks
• Code Standards
• Usage
• Contributing
• License

About

This is a GitHub repository starter template for a Go library. It has been created for anyone who wants to:

• Quickly get into Go without losing too much time on environment setup
• Create a new repository with basic Continuous Integration
• Cheat codes for all the popular Go patterns
• See: All 15+ Repository Features

Installation

go-template requires a supported release of Go.

go get -u github.com/mrz1836/go-template

Template Instructions (Temporary Section)

1. Sign up on Codecov and configure Codecov GitHub Application for all repositories
2. Click the Use this template button (alt. clone or download this repository)
3. Replace all occurrences of mrz1836/go-template to your_org/repo_name in all files
4. Replace all occurrences of go-template to repo_name in all files
5. Replace all occurrences of mrz1836 to repo_owner in all files
6. Remove or update the go-share-image.png and add to your GitHub repository (in settings)
7. Update the following files:
   • LICENSE
   • README.md
   • SECURITY.md

(Optional) Slack Message on New Release

1. Create a new Incoming Webhook
2. Set an environment variable in GitHub: SLACK_WEBHOOK

(Optional) Discord, Twitter or Reddit on New Release

Follow the instructions on GoReleaser's documentation

(Optional) Set up: All Contributors Integration

1. Follow these instructions
2. Install the local CLI: make install-all-contributors
3. Modify the .all-contributorsrc file
4. Run make update-contributors to update the list of contributors

Documentation

View the generated documentation

Repository Features

This repository was created using MrZ's go-template

Built-in Features

• Continuous integration via GitHub Actions
• Build automation via Make
• Dependency management using Go Modules
• Code formatting using gofumpt and linting with golangci-lint and yamllint
• Unit testing with testify, race detector, code coverage HTML report and Codecov report
• Releasing using GoReleaser on new Tag
• Dependency scanning and updating thanks to Dependabot and Nancy
• Security code analysis using CodeQL Action
• Automatic syndication to pkg.go.dev on every release
• Generic templates for Issues and Pull Requests in GitHub
• All standard GitHub files such as LICENSE, CONTRIBUTING.md, CODE_OF_CONDUCT.md, and SECURITY.md
• Code ownership configuration for GitHub
• All your ignore files for Visual Studio Code, docker and Git
• Automatic sync for labels into GitHub using a predefined configuration
• Built-in powerful merging rules using Mergify
• Welcome new contributors on their first Pull-Request
• Follows the standard-readme specification
• Visual Studio Code configuration with Go
• (Optional) Slack, Discord or Twitter announcements on new GitHub Releases
• (Optional) Easily add contributors in any Issue or Pull-Request

Package Dependencies

• stretchr/testify

Library Deployment

Releases are automatically created when you create a new Git tag!

If you want to manually make releases, please install GoReleaser:

goreleaser for easy binary or library deployment to GitHub and can be installed:

• using make: make install-releaser
• using brew: brew install goreleaser

The .goreleaser.yml file is used to configure goreleaser.

Automatic Releases on Tag Creation (recommended)

Automatic releases via GitHub Actions from creating a new tag:

make tag version=1.2.3

Manual Releases (optional)

Use make release-snap to create a snapshot version of the release, and finally make release to ship to production (manually).

Makefile Commands

View all makefile commands

make help

List of all current commands:

all                           Runs multiple commands
clean                         Remove previous builds and any cached data
clean-mods                    Remove all the Go mod cache
coverage                      Shows the test coverage
diff                          Show the git diff
generate                      Runs the go generate command in the base of the repo
godocs                        Sync the latest tag with GoDocs
help                          Show this help message
install                       Install the application
install-all-contributors      Installs all contributors locally
install-go                    Install the application (Using Native Go)
install-releaser              Install the GoReleaser application
lint                          Run the golangci-lint application (install if not found)
release                       Full production release (creates release in GitHub)
release                       Runs common.release then runs godocs
release-snap                  Test the full release (build binaries)
release-test                  Full production test release (everything except deploy)
replace-version               Replaces the version in HTML/JS (pre-deploy)
tag                           Generate a new tag and push (tag version=0.0.0)
tag-remove                    Remove a tag if found (tag-remove version=0.0.0)
tag-update                    Update an existing tag to current commit (tag-update version=0.0.0)
test                          Runs lint and ALL tests
test-ci                       Runs all tests via CI (exports coverage)
test-ci-no-race               Runs all tests via CI (no race) (exports coverage)
test-ci-short                 Runs unit tests via CI (exports coverage)
test-no-lint                  Runs just tests
test-short                    Runs vet, lint and tests (excludes integration tests)
test-unit                     Runs tests and outputs coverage
uninstall                     Uninstall the application (and remove files)
update-contributors           Regenerates the contributors html/list
update-linter                 Update the golangci-lint package (macOS only)
vet                           Run the Go vet application

Examples & Tests

All unit tests and examples run via GitHub Actions and uses Go version 1.22.x. View the configuration file.

Run all tests (including integration tests)

make test

Run tests (excluding integration tests)

make test-short

Benchmarks

Run the Go benchmarks:

make bench

Code Standards

Read more about this Go project's code standards.

Usage

Checkout all the examples!

Contributing

View the contributing guidelines and follow the code of conduct.

How can I help?

All kinds of contributions are welcome 🙌! The most basic way to show your support is to star 🌟 the project, or to raise issues 💬. You can also support this project by becoming a sponsor on GitHub 👏 or by making a bitcoin donation to ensure this journey continues indefinitely! 🚀

Contributors ✨

Thank you to these wonderful people (emoji key):

Mr. Z 🚇 💻 🚧 🛡️

This project follows the all-contributors specification.

License