Template for a typical module written on Go.

$ make setup
$ make help

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

$ 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

$ make tools
$ source bin/activate

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

$ 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

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.

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.

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. 🚀

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.

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

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

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

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

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

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

• 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

• 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