https://github.com/pellared/renovate-playground
https://github.com/pellared/renovate-playground
Last synced: 5 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/pellared/renovate-playground
- Owner: pellared
- License: cc0-1.0
- Created: 2025-12-17T10:24:06.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2026-01-24T04:06:57.000Z (5 months ago)
- Last Synced: 2026-01-24T15:58:50.458Z (5 months ago)
- Language: Makefile
- Size: 113 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Go Repository Template
[](https://pkg.go.dev/github.com/golang-templates/seed)
[](go.mod)
[](LICENSE)
[](https://goreportcard.com/report/github.com/golang-templates/seed)
⭐ `Star` this repository if you find it valuable and worth maintaining.
👁 `Watch` this repository to get notified about new releases, issues, etc.
## Description
This is a GitHub repository template for a Go application.
You can use it:
- to create a new repository with automation and environment setup,
- as reference when improving automation for an existing repository.
It includes:
- 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),
- linting with [golangci-lint](https://github.com/golangci/golangci-lint)
and [misspell](https://github.com/client9/misspell),
- unit testing with
[race detector](https://blog.golang.org/race-detector),
code coverage [HTML report](https://blog.golang.org/cover),
- dependencies scanning and updating thanks to [Dependabot](https://dependabot.com),
- security code analysis using [CodeQL Action](https://docs.github.com/en/github/finding-security-vulnerabilities-and-errors-in-your-code/about-code-scanning),
and [govulncheck](https://pkg.go.dev/golang.org/x/vuln/cmd/govulncheck),
- [Visual Studio Code](https://code.visualstudio.com) configuration with
[Go](https://code.visualstudio.com/docs/languages/go) support.
## Usage
1. Click the `Use this template` button (alt. clone or download this repository).
1. Replace all occurrences of `golang-templates/seed` to
`your_org/repo_name` in all files.
1. Replace all occurrences of `seed` to `repo_name` in [Dockerfile](Dockerfile).
1. Update the following files:
- [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md)
- [LICENSE](LICENSE)
- [README.md](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](https://www.jetbrains.com/go/),
[Vim](https://github.com/fatih/vim-go), [Emacs](https://github.com/dominikh/go-mode.el).
However, take notice that the Visual Studio Go extension is
[officially supported](https://blog.golang.org/vscode-go) by the Go team.
1. Install [Go](https://golang.org/doc/install).
1. Install [Visual Studio Code](https://code.visualstudio.com/).
1. Install [Go extension](https://code.visualstudio.com/docs/languages/go).
1. Clone and open this repository.
1. `F1` -> `Go: Install/Update Tools` -> (select all) -> OK.
## Build
### Terminal
- `make` - execute the build pipeline.
- `make help` - print help for the [Make targets](Makefile).
### Visual Studio Code
`F1` → `Tasks: Run Build Task (Ctrl+Shift+B or ⇧⌘B)` to execute the build pipeline.
## Release
The release workflow is triggered each time a tag with `v` prefix is pushed.
_CAUTION_: Make sure to understand the consequences before you bump the major version.
More info: [Go Wiki](https://github.com/golang/go/wiki/Modules#releasing-modules-v2-or-higher),
[Go Blog](https://blog.golang.org/v2-go-modules).
## Maintenance
Notable files:
- [.github/workflows](.github/workflows) - GitHub Actions workflows,
- [.github/dependabot.yml](.github/dependabot.yml) - Dependabot configuration,
- [.vscode](.vscode) - Visual Studio Code configuration files,
- [.golangci.yml](.golangci.yml) - golangci-lint configuration,
- [Dockerfile](Dockerfile) - Dockerfile for containerization,
- [Makefile](Makefile) - Make targets used for development,
[CI build](.github/workflows) and [.vscode/tasks.json](.vscode/tasks.json).
## FAQ
### Why Visual Studio Code editor configuration
Developers that use Visual Studio Code can take advantage of the editor configuration.
While others do not have to care about it.
Setting configs for each repo is unnecessary time consuming.
VS Code is the most popular Go editor ([survey](https://blog.golang.org/survey2019-results))
and it is officially [supported by the Go team](https://blog.golang.org/vscode-go).
You can always remove the [.vscode](.vscode) directory
if it really does not help you.
### Why GitHub Actions, not any other CI server
GitHub Actions is out-of-the-box if you are already using GitHub.
You can learn how to use it for Go in the [GitHub Actions for Go guide](https://github.com/mvdan/github-actions-golang).
However, changing to any other CI server should be very simple,
because this repository has build logic and tooling installation in [Makefile](Makefile).
### How can I build on Windows
Install [tdm-gcc](https://jmeubank.github.io/tdm-gcc/)
and copy `C:\TDM-GCC-64\bin\mingw32-make.exe`
to `C:\TDM-GCC-64\bin\make.exe`.
Alternatively, you may install [mingw-w64](http://mingw-w64.org/doku.php)
and copy `mingw32-make.exe` accordingly.
Take a look at [this GitHub issue](https://github.com/docker-archive/toolbox/issues/673#issuecomment-355275054),
if you have problems using Docker in Git Bash.
You can also use [WSL (Windows Subsystem for Linux)](https://docs.microsoft.com/en-us/windows/wsl/install-win10)
or develop inside a [Remote Container](https://code.visualstudio.com/docs/remote/containers).
However, take into consideration that then you are not going to use
"bare-metal" Windows.
Consider using [goyek](https://github.com/goyek/goyek)
for creating cross-platform build pipelines in Go.
## Contributing
Feel free to create an issue or propose a pull request.
Follow the [Code of Conduct](CODE_OF_CONDUCT.md).