eric/ReleaseKit
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 1 Wiki Activity

Establish the Go module baseline

Browse Source
This commit is contained in:
Eric Rakestraw
2026-10-05 16:38:13 +00:00
parent cc7ca47469
commit 9e855c81a6
5 changed files with 43 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@@ -1,9 +1,17 @@
# ReleaseKit # ReleaseKit
ReleaseKit is being designed as an opinionated Go library and executable for a ReleaseKit is an opinionated Go library and executable for a shared release
shared release process. The repository currently contains policies, architectural process. The Go module and documented root `releasekit` facade are established;
decisions, and implementation proposals. Go packages, commands, and release the library operations, runtime version package, executable, tests, and release
automation have not been implemented. 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 ## Documentation

3
doc.go Normal file
View File

@@ -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

24
docs/development.md
View File

@@ -1,8 +1,9 @@
# Developing ReleaseKit # Developing ReleaseKit
ReleaseKit currently contains adopted policies and design documents. See the ReleaseKit contains a Go module with the documented root `releasekit` facade,
[README](../README.md) for orientation and the [product roadmap](roadmap/releasekit.md) adopted policies, and design documents. See the [README](../README.md) for
for proposed capabilities and implementation sequencing. 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. Read the [agent policy](policy/agents.md) and inspect the worktree before editing.
Preserve unrelated changes and follow explicit instructions about commits. Preserve unrelated changes and follow explicit instructions about commits.
@@ -35,6 +36,17 @@ documentation topic map.
## Validation ## 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, For prose changes, review the diff and check local links, fragment destinations,
provenance, template residue, and consistency with current repository contents. provenance, template residue, and consistency with current repository contents.
Check prose whitespace with: Check prose whitespace with:
@@ -47,7 +59,7 @@ git diff --cached --check -- '*.md' COPYRIGHT
Verbatim license texts retain their supplied formatting. When changing those Verbatim license texts retain their supplied formatting. When changing those
texts, compare their bytes with the selected upstream source. texts, compare their bytes with the selected upstream source.
There is no `go.mod`, default test suite, or publication command yet. Add working There is no publication command yet. Add working development commands here as
development commands here as implementation lands. Add `docs/release.md` with implementation lands. Add `docs/release.md` with the first working publication
the first working publication command; the [policy adoption roadmap](roadmap/policy.md#4-define-releasekits-own-release-path) command; the [policy adoption roadmap](roadmap/policy.md#4-define-releasekits-own-release-path)
records the remaining bootstrap work. records the remaining bootstrap work.

8
docs/roadmap/implementation.md
View File

@@ -435,7 +435,7 @@ arbitrary toolchains or elapsed time are not promised.
## Stage 1: Establish the Go module and development baseline ## 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 1. Add the module with the selected path and language baseline. Add root package
documentation for the orchestration facade and establish ordinary Go layout. 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. toolchain and network disabled. Review module identity and licensing notices.
Do not invent tests merely to assert that an empty package exists. 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 ## Stage 2: Implement the runtime version facade
Status: Pending. Depends on Stage 1. Status: Pending. Depends on Stage 1.

3
go.mod Normal file
View File

@@ -0,0 +1,3 @@
module gitea.maximumdirect.net/eric/ReleaseKit
go 1.25.0