common

README

SpliceFS common

The Go packages that the SpliceFS server and client both use. Each program names the version of this module it is built against in its go.mod.

Package	What it holds
wire	the JSON bodies and header names of the HTTP API, version 1
units	the size and duration types used in the configuration files

A package belongs here only if both programs need it, and it is named for what it does.

Use

go get github.com/SpliceFS/common

import "github.com/SpliceFS/common/units"
import "github.com/SpliceFS/common/wire"

Building

Requires Go 1.26 or newer.

make check        # everything CI runs: format check, vet, tests with the race detector, coverage gate
make check-linux  # the same on Linux, in a container (needs Docker)
make lint         # golangci-lint

Versioning

This module follows Semantic Versioning. Releases are git tags of the form vMAJOR.MINOR.PATCH. A change to the JSON that wire describes is a change to the HTTP API, which is specified in the design document of the server. Before 1.0.0 the packages may change in any minor release; every change is listed in the changelog.

License

MIT. See LICENSE.