Development

Golang

Ensure you have installed go in your system.

To keep the project maintained, when developing use these commands:

go mod tidy
go get -u ./...
go test -cover ./...
go test -race ./...

To run the github workflows locally:

act push -W .github/workflows/ci.yml --container-architecture linux/amd64 \
  --env GORELEASER_CURRENT_TAG=v0.0.1-local

To check what the goreleaser tool is generating locally:

AUR_KEY="" goreleaser release --snapshot --skip=publish --clean

To deploy act and goreleaser in an Arch Linux system:

run0 pacman -S act goreleaser podman upx
systemctl --user enable --now podman.socket
act # The medium size image is enough

To maintain code quality, many pre-commit hooks must run before commiting changes.

Install pre-commit in your machine: pacman -S pre-commit.

After cloning the repo, install the pre-commit hooks: pre-commit install.

To check every hook without commiting, you can run pre-commit run --all-files.