54 lines
2.1 KiB
Markdown
54 lines
2.1 KiB
Markdown
# ReleaseKit
|
|
|
|
ReleaseKit is an opinionated Go library and executable for a shared release
|
|
process. The Go module, root `releasekit` facade, `buildinfo` runtime package,
|
|
local candidate check, source-tag publication API, and `version` and `check`
|
|
commands are implemented. A publication command, builds, delivery, 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 version command prints ReleaseKit's version:
|
|
|
|
```sh
|
|
go run ./cmd/releasekit version
|
|
```
|
|
|
|
The local candidate check validates a committed release note and runs the
|
|
configured checks (or the default offline Go test command):
|
|
|
|
```sh
|
|
go run ./cmd/releasekit check v1.2.3
|
|
```
|
|
|
|
## 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 `version` and local `check` commands.
|
|
- [Configuration](docs/config.md): profile fields and child-command settings.
|
|
- [Runtime version guidance](docs/consumers/runtime-version.md): how applications
|
|
read their embedded version through `buildinfo`.
|
|
- [Candidate check guidance](docs/consumers/check.md): local candidate validation
|
|
through the Go API and CLI.
|
|
- [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.
|