Add runtime version reporting
This commit is contained in:
17
README.md
17
README.md
@@ -1,10 +1,11 @@
|
||||
# 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
|
||||
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:
|
||||
@@ -13,6 +14,12 @@ Run the offline Go test suite from the repository root with:
|
||||
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,
|
||||
@@ -21,6 +28,8 @@ go test ./...
|
||||
policy reading.
|
||||
- [Architecture policy](docs/policy/architecture.md): responsibility and dependency
|
||||
boundaries for development.
|
||||
- [Runtime version guidance](docs/runtime.md): how applications read their
|
||||
embedded version through `buildinfo`.
|
||||
- [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.
|
||||
|
||||
Reference in New Issue
Block a user