🧩 Module

Template for a typical module written on Go.

🛫 Quick start

Work with Makefile

$ make setup
$ make help

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

For more details please visit the page.

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

For more details please visit the page.

Work with tools

$ make tools
$ source bin/activate

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

For more details please visit the page.

Work with Docker

$ make go-1.11 # or go-1.12, etc.
/src# make go-env 2>/dev/null | grep GOVERSION
# GOVERSION:   1.11.13
/src# make test

🚧 Work with documentation

• https://go-module.octolab.org/ - GitHub Pages
• https://go-module.pages.dev/ - Cloudflare Pages

💡 Idea

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

🏆 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 module

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

Contribute to the template

1. Read the contribution guidelines.
2. Fork the repository.
3. Make your changes.
4. Send a pull request.
5. 🤗

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

1. GitHub Actions.
2. GitHub Pages.
3. Dependabot.

Included

1. Nextra.
2. Makefiles.
3. Taskfiles.
4. Go tools: mockgen, golangci-lint, goimports, govulncheck.

Optional

1. Bitbucket¹.
2. Cloudflare Pages².
3. Codecov.
4. GitHub Socialify.
5. Go Report Card.
6. Settings³.
7. Shields.io.
8. Slack.
9. Vanity URL.

Coming soon

1. CodeQL (code scanning).
2. Graphite (git workflow).
3. Qodana (code quality).
4. SonarCloud (code quality).
5. Vercel (docs preview).

🛬 Integration

The project uses SemVer for versioning, and it is not BC-safe through major releases. Please use Go Modules to manage its version.

$ go get go.octolab.org@latest

🏗️ Ecosystem

Input

• https://github.com/kamilsk/retry
• https://github.com/kamilsk/semaphore
• https://github.com/kamilsk/tracer
• https://github.com/octolab/breaker

Impact

• https://github.com/octomation/go-tool
• https://github.com/octomation/maintainer
• https://github.com/octomation/makefiles
• https://github.com/octomation/taskfiles
• https://github.com/octomation/vanity

Output

• https://github.com/octolab/cli*
• https://github.com/octolab/config
• https://github.com/octolab/pkg*
• https://github.com/octolab/propaganda
• https://github.com/octolab/protocol*

made with ❤️ for everyone by OctoLab

Footnotes

1. An alternative for backup could be GitLab, Gogs, or Gitea. ↩

2. Useful for private repositories. ↩

3. It has been deprecated and will be replaced someday by GitHub Actions. ↩