Skip to content

Latest commit

 

History

History
71 lines (49 loc) · 1.38 KB

DEVELOPMENT.md

File metadata and controls

71 lines (49 loc) · 1.38 KB
Raw

Developer guide

Setting up

Requirements:

  • Go (v1.22.0 or higher)
  • Node.js (v20.11.1 or higher)
  • pnpm (v8.15.3 or higher)
  • Task (v3.34.1 or higher)

install dependencies:

task install

Workflow

Note

You can discover all available tasks by running task -l.

Here, we introduce the main tasks.

Linting

: linting
task lint
: formatting
task format

Generating code

Some test mock code (internal/syncup/**/mock/mock_*.go) and certain documents, such as the command reference (docs/reference/*.md), are automatically generated.

For automatic generation, we use go generate. You can find hints about the content of automatic generation by looking for code comments that start with //go:generate.

task generate

Testing

task test

Build

: build executable binary only
task build
: build and archive executable binary
task archive

Release

Warning

The specified version will be released, so double-check before executing.

The release task is available only on main branch. NEXT_VERSION environment variable is required and must follow Semantic Versioning.

git checkout main
NEXT_VERSION=vx.x.x task release