# ReleaseKit

ReleaseKit is an opinionated Go library and executable for a shared release
process. The Go module, root `releasekit` facade, `buildinfo` runtime package,
and `releasekit version` command are established; the library operations beyond
runtime version access, remaining CLI commands, and release automation remain
to be implemented. Their selected behavior and sequence are described in the
[product roadmap](docs/roadmap/releasekit.md) and
[implementation plan](docs/roadmap/implementation.md).

Run the offline Go test suite from the repository root with:

```sh
go test ./...
```

The current command prints ReleaseKit's version:

```sh
go run ./cmd/releasekit version
```

## Documentation

- [ReleaseKit proposal](docs/roadmap/releasekit.md): proposed publication, builds,
  version injection, and delivery, with the initial implementation plan.
- [Contributor guide](docs/development.md): orientation, validation, and selective
  policy reading.
- [CLI contract](docs/cli.md): the current `version` command and its output.
- [Runtime version guidance](docs/consumers/runtime-version.md): how applications
  read their embedded version through `buildinfo`.
- [Internal package inventory](docs/internal/overview.md): implemented internal
  components and their responsibilities.
- [Architecture policy](docs/policy/architecture.md): responsibility and dependency
  boundaries for development.
- [ADR 0001](docs/adr/0001-public-facade.md): the accepted public facade decision.
- [Policy adoption roadmap](docs/roadmap/policy.md): completed adoption and pending
  release bootstrap work.

ReleaseKit is licensed under the [LGPL v3.0 or later](COPYRIGHT).

[Open Source attribution notices](docs/oss/attribution.md) are available.