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

Record the agreed v0.2.0 validation decisions

Browse Source
This commit is contained in:
Eric Rakestraw
2026-10-07 16:54:12 +00:00
parent f4a32dae73
commit f9f0349eca
2 changed files with 12 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/roadmap/model.md
View File

@@ -73,8 +73,10 @@ offline validation, and source-publication outcomes retain their meaning.
File-oriented checks share candidate-file enumeration and inspection where
useful. Their scope is the captured candidate, and inspection remains offline
and read-only. Module-distribution rules inspect the files being released
independently of the environment used to run Go commands. Markdown boundary
and read-only. Inspect committed candidate contents and define symlink and
submodule handling explicitly in the shared inspection model. Module-distribution
rules inspect the files being released independently of the environment used
to run Go commands. Markdown boundary
validation operates independently of neighboring checkout contents.
Keep each check's settings together: Markdown validation owns its optional

12
docs/roadmap/v0.2.0.md
View File

@@ -179,6 +179,8 @@ for those targets within candidate validation, after the selected test and vet
work. `Check` and `Publish` share this behavior and report compilation failures
through their existing outcomes.
Package compilation uses the existing pure-Go build baseline (`CGO_ENABLED=0`).
A source-only library retains page-only delivery. Package-compilation checks
require no binary name, version smoke command, or artifact manifest. Successful
compilation establishes build compatibility; execution on a target remains a
@@ -209,8 +211,9 @@ outside ReleaseKit would duplicate destination-resolution work.
### Target end state
An optional public API and profile setting declares the expected publication
destination. `Publish` compares it with the resolved push endpoint before
candidate validation and publication. A mismatch produces a clear failure.
destination. `Publish` compares it exactly with the effective push URL resolved
by Git before candidate validation and publication. A mismatch produces a clear
failure.
The existing captured-endpoint, recheck, and recovery machinery continues to
govern the operation.
@@ -284,8 +287,9 @@ read-only validation and report the source file, location, and target of each
problem.
ReleaseKit owns a documented link and heading-anchor convention that consumers
can follow. The supported behavior accounts for common inline and reference
links, code examples, escaped destinations, and duplicate headings. External
can follow, using PromptKit's current conventions as the starting specification.
The supported behavior accounts for common inline and reference links, code
examples, escaped destinations, and duplicate headings. External
website availability is outside the check's scope.
By default, links outside the checkout are classified and reported as outside