31 lines
1.2 KiB
Markdown
31 lines
1.2 KiB
Markdown
# ReleaseKit
|
|
|
|
ReleaseKit is an opinionated Go library and executable for a shared release
|
|
process. The Go module and documented root `releasekit` facade are established;
|
|
the library operations, runtime version package, executable, tests, 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 ./...
|
|
```
|
|
|
|
## 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.
|
|
- [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.
|