Skip to content

Latest commit

 

History

History
278 lines (207 loc) · 8.17 KB

README.md

File metadata and controls

278 lines (207 loc) · 8.17 KB
Raw

Go Tool

Coverage Quality Documentation CI/CD Promo Mirror Template

🧩 Tool

Template for a typical CLI-tool 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.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 CLI-tool. Not only does it provide a starting point for new projects, but it comes equipped with pre-configured ci/cd and inventory.

$ tool do action

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

  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/tool.
  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, goreleaser, godownloader, goimports, govulncheck.

Optional

  1. Bitbucket1.
  2. Codecov.
  3. Slack.
  4. Settings2.
  5. Go Report Card.
  6. Shields.io.
  7. GitHub Socialify.

Coming soon

  1. CodeQL (code scanning).
  2. Graphite (git workflow).
  3. Qodana (code quality).
  4. SonarCloud (code quality).
  5. Vanity URL (canonical import path).
  6. Vercel (docs preview).

🛬 Installation

Homebrew

$ brew install octolab/tap/tool

For more details please visit the page.

Binary

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

For more details please visit the page.

Source

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

For more details please visit the page.

Shell completions

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

🏗️ Ecosystem

Input

Impact

Actions

🚧 Work in progress.

Custom forks

Output

made with ❤️ for everyone by OctoLab

Footnotes

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

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