go-cloud-run

Go Repository Template for Google Cloud Run

This is a GitHub repository template for Go

It includes:

• continous integration via GitHub Actions,
• dependency management using Go Modules,
• code formatting using gofumpt,
• linting with golangci-lint,
• Codecov report,
• dependencies scanning and updating thanks to Dependabot,
• Visual Studio Code configuration with Go

Usage

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 occurences of dev-templates/go-cloud-run to your_org/repo_name in all files.
4. Rename folder cmd/go-cloud-run to cmd/app_name.
5. Replace gcr.io/app/server to gcr.io/<PROJECT_ID>/<IMAGE_ID>/repo_name in docker-compose.yml.
6. Update LICENSE and README.md.

Build

• Visual Studio Code: Terminal → Run Build Task... (Ctrl+Shift+P => Tasks: Run Task) to execute a fast build or run docker-compose.

Maintainance

Notable files:

• .github/workflows - GitHub Actions workflows,
• .github/dependabot.yml - Dependabot configuration,
• .vscode - Visual Studio Code configuration files,
• go.mod - Go module definition,