diff --git a/README.md b/README.md index bec67b0..f02aed6 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,17 @@ # ReleaseKit -ReleaseKit is being designed as an opinionated Go library and executable for a -shared release process. The repository currently contains policies, architectural -decisions, and implementation proposals. Go packages, commands, and release -automation have not been implemented. +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 diff --git a/doc.go b/doc.go new file mode 100644 index 0000000..a594f18 --- /dev/null +++ b/doc.go @@ -0,0 +1,3 @@ +// Package releasekit is the public facade for ReleaseKit's release process. +// Public operations are added as their behavior is implemented. +package releasekit diff --git a/docs/development.md b/docs/development.md index 03dc976..8e88403 100644 --- a/docs/development.md +++ b/docs/development.md @@ -1,8 +1,9 @@ # Developing ReleaseKit -ReleaseKit currently contains adopted policies and design documents. See the -[README](../README.md) for orientation and the [product roadmap](roadmap/releasekit.md) -for proposed capabilities and implementation sequencing. +ReleaseKit contains a Go module with the documented root `releasekit` facade, +adopted policies, and design documents. See the [README](../README.md) for +orientation and the [product roadmap](roadmap/releasekit.md) for proposed +capabilities and implementation sequencing. Read the [agent policy](policy/agents.md) and inspect the worktree before editing. Preserve unrelated changes and follow explicit instructions about commits. @@ -35,6 +36,17 @@ documentation topic map. ## Validation +Run the offline Go test suite from the repository root with: + +```sh +go test ./... +``` + +The implemented package inventory currently contains only the root +`releasekit` facade package. Its public operations are added as their behavior is +implemented; see the [implementation plan](roadmap/implementation.md) for +current progress. + For prose changes, review the diff and check local links, fragment destinations, provenance, template residue, and consistency with current repository contents. Check prose whitespace with: @@ -47,7 +59,7 @@ git diff --cached --check -- '*.md' COPYRIGHT Verbatim license texts retain their supplied formatting. When changing those texts, compare their bytes with the selected upstream source. -There is no `go.mod`, default test suite, or publication command yet. Add working -development commands here as implementation lands. Add `docs/release.md` with -the first working publication command; the [policy adoption roadmap](roadmap/policy.md#4-define-releasekits-own-release-path) +There is no publication command yet. Add working development commands here as +implementation lands. Add `docs/release.md` with the first working publication +command; the [policy adoption roadmap](roadmap/policy.md#4-define-releasekits-own-release-path) records the remaining bootstrap work. diff --git a/docs/roadmap/implementation.md b/docs/roadmap/implementation.md index 47f4ddb..9fd1560 100644 --- a/docs/roadmap/implementation.md +++ b/docs/roadmap/implementation.md @@ -435,7 +435,7 @@ arbitrary toolchains or elapsed time are not promised. ## Stage 1: Establish the Go module and development baseline -Status: Pending. Depends on the baseline only. +Status: Complete. Depends on the baseline only. 1. Add the module with the selected path and language baseline. Add root package documentation for the orchestration facade and establish ordinary Go layout. @@ -448,6 +448,12 @@ Acceptance: module loading and `go test ./...` work with the prepared local toolchain and network disabled. Review module identity and licensing notices. Do not invent tests merely to assert that an empty package exists. +Completion evidence: added the Go 1.25.0 module and documented root facade, +updated the README and developer guide to describe the implemented boundary and +offline test command, and confirmed module loading and `go test ./...` with +network access disabled. The module has no external dependencies; existing +LGPL licensing and attribution notices remain consistent. + ## Stage 2: Implement the runtime version facade Status: Pending. Depends on Stage 1. diff --git a/go.mod b/go.mod new file mode 100644 index 0000000..0c35f27 --- /dev/null +++ b/go.mod @@ -0,0 +1,3 @@ +module gitea.maximumdirect.net/eric/ReleaseKit + +go 1.25.0