Add local candidate validation
This commit is contained in:
19
README.md
19
README.md
@@ -2,9 +2,9 @@
|
||||
|
||||
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
|
||||
local candidate check, and `version` and `check` commands are implemented.
|
||||
Publication, build, 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).
|
||||
|
||||
@@ -14,22 +14,31 @@ Run the offline Go test suite from the repository root with:
|
||||
go test ./...
|
||||
```
|
||||
|
||||
The current command prints ReleaseKit's version:
|
||||
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 current `version` command and its output.
|
||||
- [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
|
||||
|
||||
Reference in New Issue
Block a user