sdk

README

paper-board/sdk

Shared Go library for paper-board services. SemVer 2.0 disciplined.

Packages

• migrator/ — golang-migrate wrapper with cobra CLI; per-service advisory lock; embed.FS source. See ADR-0004.
• log/ — slog-based structured logging; ctx-aware Pkg(ctx) helper auto-injects request_id, trace_id, org_id, user_id.
• obs/ — OpenTelemetry SDK setup; Phase 1.0 placeholder, Phase 1.5 real OTLP exporter.
• errors/ — sentinel errors + gRPC code mapping (ToGRPCStatus, FromGRPCStatus).

Usage

// cmd/migrator/main.go (in your service repo, ~30 lines)
package main

import (
    "context"
    "log"
    "os"

    "github.com/paper-board/sdk/migrator"
    "github.com/paper-board/identity/migrations"  // your service's embed
)

func main() {
    cfg := migrator.Config{
        DBURL:          os.Getenv("MIGRATION_DB_URL"),
        Schema:         "identity",
        AdvisoryLockID: 1, // identity=1, billing=2, agents=3, platform=4
        EmbedFS:        migrations.SchemaFS,
        EmbedRoot:      "schema",
    }
    if err := migrator.Run(context.Background(), cfg, os.Args[1:]); err != nil {
        log.Fatal(err)
    }
}

Versioning

SemVer strict:

• major — breaking API change
• minor — additive (new function, new field)
• patch — bug fix, doc fix

Each minor/patch bump triggers Renovate auto-PR in dependent service repos.

Development

go mod tidy
go test -race -count=1 ./...

Integration tests use testcontainers-go for Postgres. Requires Docker.

License

MIT.