GitHub Actions: add code coverage integration

🧩 Service

Template for a typical service written on Go.

🛫 Quick start

Work with Makefile

$ make setup
$ make help

$ make find-todos
$ make test lint
$ TIMEOUT=5s make test-with-coverage

Work with Taskfile

$ alias run=./Taskfile
$ run refresh
$ run help

$ run docs # === `run docs install -- build -- start`
$ run docs npm ci
$ run docs npm i nextra@latest

$ run tools go generate tools.go
$ run tools golangci-lint --version -- mockgen --version
$ run which goimports golangci-lint govulncheck mockgen

Work with Tools

$ make tools
$ source bin/activate

$ which goimports
$ goimports -local $(go list -m) -w ./...

Work with Docker

$ make go-1.19 # or go-1.20, etc.
/src# make go-env 2>/dev/null | grep GOVERSION
# GOVERSION:   1.19.10
/src# make test

💡 Idea

Define a powerful template that quickly creates a new Go service. Not only does it provide a starting point for new projects, but it comes equipped with pre-configured ci/cd and inventory.

$ server up &
$ client call

🏆 Motivation

At OctoLab, we want to start new projects faster using best practices with a predefined structure and focusing on core ideas implementation rather than wasting time on environment configuration and copying boilerplate code.

🤼‍ How to

Build your own service

Generate a new repository from the template.
Clone the repository locally.
Update the desired files as needed, e.g., run init my.new/service.
Write your code and tests.
🚀

Contribute to the template

Read the contribution guidelines.
Fork the repository.
Make your changes.
Send a pull request.
🤗

Before you start, please make sure your changes are in demand. The best for that is to create a new discussion, or if you find an issue, report it first.

🎛️ Configuration

Pre-configured

Included

Nextra.
Makefiles.
Taskfiles.
Go tools:
- mockgen
- goimports
- golangci-lint
- govulncheck
- goreleaser
- godownloader
- protobuf
- buf
- grpc
- grpc-gateway
- twirp

Optional

Coming soon

Cloudflare Pages (docs hosting).
CodeQL (code scanning).
Graphite (git workflow).
Qodana (code quality).
SonarCloud (code quality).
Vanity URL (canonical import path).
Vercel (docs hosting).

🛬 Installation

Homebrew

$ brew install octolab/tap/service

Binary

$ curl -fsSL https://install.octolab.org/octomation/service | sh
# or
$ wget -qO-  https://install.octolab.org/octomation/service | sh

Source

# use standard go tools
$ go get go.octolab.org/template/service/cmd/client@latest
$ go get go.octolab.org/template/service/cmd/server@latest
# or use egg tool
$ egg tools add go.octolab.org/template/service/cmd/client@latest
$ egg tools add go.octolab.org/template/service/cmd/server@latest

Shell completions

$ client completion > /path/to/completions/...
# or
$ source <(client completion)

🏗️ Ecosystem

Input

Impact

Output

https://github.com/withsparkle/service

made with ❤️ for everyone by OctoLab

An alternative for backup could be GitLab, Gogs, or Gitea. ↩
It has been deprecated and will be replaced someday by GitHub Actions. ↩

	// TODO:remove by golangci-lint update
	replace github.com/blizzy78/varnamelen => github.com/blizzy78/varnamelen v0.8.0

	root.AddCommand(
	cobra.NewVersionCommand(version, date, commit, cnf.Features...),
	)

octomation / go-service Goto Github PK

go-service's Introduction