Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mrz1836/go-template
📋 Robust starter template for a new Go library
https://github.com/mrz1836/go-template
continuous-integration discord github-actions github-template gitpod go go-template golang goreleaser mergify slack template testify
Last synced: 3 months ago
JSON representation
📋 Robust starter template for a new Go library
- Host: GitHub
- URL: https://github.com/mrz1836/go-template
- Owner: mrz1836
- License: mit
- Created: 2021-08-23T20:45:25.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2024-10-07T05:11:14.000Z (4 months ago)
- Last Synced: 2024-10-14T00:07:13.983Z (3 months ago)
- Topics: continuous-integration, discord, github-actions, github-template, gitpod, go, go-template, golang, goreleaser, mergify, slack, template, testify
- Language: Makefile
- Homepage:
- Size: 354 KB
- Stars: 13
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: .github/SECURITY.md
- Support: .github/SUPPORT.md
Awesome Lists containing this project
README
# go-template
> Robust starter template for a new Go library
[](https://github.com/mrz1836/go-template/releases)
[](https://github.com/mrz1836/go-template/actions)
[](https://goreportcard.com/report/github.com/mrz1836/go-template)
[](https://codecov.io/gh/mrz1836/go-template)
[](https://mergify.io)
[](https://golang.org/)
[](https://gitpod.io/#https://github.com/mrz1836/go-template)
[](https://github.com/RichardLitt/standard-readme)
[](Makefile)
[](https://github.com/sponsors/mrz1836)
[](https://gobitcoinsv.com/#sponsor?utm_source=github&utm_medium=sponsor-link&utm_campaign=go-template&utm_term=go-template&utm_content=go-template)
## Table of Contents
- [About](#about)
- [Installation](#installation)
- [Documentation](#documentation)
- [Examples & Tests](#examples--tests)
- [Benchmarks](#benchmarks)
- [Code Standards](#code-standards)
- [Usage](#usage)
- [Contributing](#contributing)
- [License](#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](#documentation)**
## Installation
**go-template** requires a [supported release of Go](https://golang.org/doc/devel/release.html#policy).
```shell script
go get -u github.com/mrz1836/go-template
```
### Template Instructions (Temporary Section)
1. Sign up on [Codecov](https://codecov.io/) and configure [Codecov GitHub Application](https://github.com/apps/codecov) 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`](.github/IMAGES/go-share-image.png) and add to your GitHub repository (in settings)
7. Update the following files:
- [LICENSE](LICENSE)
- [README.md](README.md)
- [SECURITY.md](.github/SECURITY.md)
#### (Optional) Slack Message on New Release
1. Create a new [Incoming Webhook](https://api.slack.com/messaging/webhooks)
2. Set an environment variable in GitHub: `SLACK_WEBHOOK`
#### (Optional) Discord, Twitter or Reddit on New Release
Follow the instructions on [GoReleaser's documentation](https://goreleaser.com/customization/announce/#discord)
#### (Optional) Set up: All Contributors Integration
1. Follow these [instructions](https://allcontributors.org/docs/en/bot/installation)
2. Install the local CLI: `make install-all-contributors`
3. Modify the [.all-contributorsrc](.all-contributorsrc) file
4. Run `make update-contributors` to update the list of contributors
## Documentation
View the generated [documentation](https://pkg.go.dev/github.com/mrz1836/go-template)
[](https://pkg.go.dev/github.com/mrz1836/go-template)
Repository Features
This repository was created using [MrZ's `go-template`](https://github.com/mrz1836/go-template#about)
### Built-in Features
- Continuous integration via [GitHub Actions](https://github.com/features/actions)
- Build automation via [Make](https://www.gnu.org/software/make)
- Dependency management using [Go Modules](https://github.com/golang/go/wiki/Modules)
- Code formatting using [gofumpt](https://github.com/mvdan/gofumpt) and linting with [golangci-lint](https://github.com/golangci/golangci-lint) and [yamllint](https://yamllint.readthedocs.io/en/stable/index.html)
- Unit testing with [testify](https://github.com/stretchr/testify), [race detector](https://blog.golang.org/race-detector), code coverage [HTML report](https://blog.golang.org/cover) and [Codecov report](https://codecov.io/)
- Releasing using [GoReleaser](https://github.com/goreleaser/goreleaser) on [new Tag](https://git-scm.com/book/en/v2/Git-Basics-Tagging)
- Dependency scanning and updating thanks to [Dependabot](https://dependabot.com) and [Nancy](https://github.com/sonatype-nexus-community/nancy)
- Security code analysis using [CodeQL Action](https://docs.github.com/en/github/finding-security-vulnerabilities-and-errors-in-your-code/about-code-scanning)
- Automatic syndication to [pkg.go.dev](https://pkg.go.dev/) on every release
- Generic templates for [Issues and Pull Requests](https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository) in GitHub
- All standard GitHub files such as `LICENSE`, `CONTRIBUTING.md`, `CODE_OF_CONDUCT.md`, and `SECURITY.md`
- Code [ownership configuration](.github/CODEOWNERS) for GitHub
- All your ignore files for [Visual Studio Code](.editorconfig), [docker](.dockerignore) and [Git](.gitignore)
- Automatic sync for [labels](.github/labels.yml) into GitHub using a predefined [configuration](.github/labels.yml)
- Built-in powerful merging rules using [Mergify](https://mergify.io/)
- Welcome [new contributors](.github/mergify.yml) on their first Pull-Request
- Follows the [standard-readme](https://github.com/RichardLitt/standard-readme/blob/master/spec.md) specification
- [Visual Studio Code](https://code.visualstudio.com) configuration with [Go](https://code.visualstudio.com/docs/languages/go)
- (Optional) [Slack](https://slack.com), [Discord](https://discord.com) or [Twitter](https://twitter.com) announcements on new GitHub Releases
- (Optional) Easily add [contributors](https://allcontributors.org/docs/en/bot/installation) in any Issue or Pull-Request
Package Dependencies
- [stretchr/testify](https://github.com/stretchr/testify)
Library Deployment
Releases are automatically created when you create a new [Git tag](https://git-scm.com/book/en/v2/Git-Basics-Tagging)!
If you want to manually make releases, please install GoReleaser:
[goreleaser](https://github.com/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](.goreleaser.yml) file is used to configure [goreleaser](https://github.com/goreleaser/goreleaser).
### Automatic Releases on Tag Creation (recommended)
Automatic releases via [GitHub Actions](.github/workflows/release.yml) from creating a new tag:
```shell
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
```shell script
make help
```
List of all current commands:
```text
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](examples) run via [GitHub Actions](https://github.com/mrz1836/go-template/actions) and
uses [Go version 1.22.x](https://golang.org/doc/go1.22). View the [configuration file](.github/workflows/run-tests.yml).
Run all tests (including integration tests)
```shell script
make test
```
Run tests (excluding integration tests)
```shell script
make test-short
```
## Benchmarks
Run the Go benchmarks:
```shell script
make bench
```
## Code Standards
Read more about this Go project's [code standards](.github/CODE_STANDARDS.md).
## Usage
Checkout all the [examples](examples)!
## Contributing
View the [contributing guidelines](.github/CONTRIBUTING.md) and follow the [code of conduct](.github/CODE_OF_CONDUCT.md).
### How can I help?
All kinds of contributions are welcome :raised_hands:!
The most basic way to show your support is to star :star2: the project, or to raise issues :speech_balloon:.
You can also support this project by [becoming a sponsor on GitHub](https://github.com/sponsors/mrz1836) :clap:
or by making a [**bitcoin donation**](https://gobitcoinsv.com/#sponsor?utm_source=github&utm_medium=sponsor-link&utm_campaign=go-template&utm_term=go-template&utm_content=go-template) to ensure this journey continues indefinitely! :rocket:
[](https://github.com/mrz1836/go-template/stargazers)
### Contributors ✨
Thank you to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
> This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification.
## License
[](LICENSE)
