Complete module release documentation

This commit is contained in:
2026-10-10 04:03:42 +00:00
parent b49c1f379e
commit 90559fe01b
18 changed files with 260 additions and 45 deletions

View File

@@ -26,7 +26,7 @@ type Candidate struct {
ModulePath string
Tag string
Commit string
Version string
Version string // selected stable semantic version.
}
// ReleaseRequest contains the inputs used to validate and optionally build one
@@ -37,8 +37,8 @@ type ReleaseRequest struct {
// ModuleDir selects a repository-relative module directory; empty selects
// the repository root.
ModuleDir string
Product string
Version string
Product string
Version string // stable semantic version, independent of the derived Git tag.
Remote string
// ExpectedPushURL optionally requires Publish's resolved push URL to match
// this string exactly before validation or tag creation. Check ignores this
@@ -56,8 +56,10 @@ type ReleaseRequest struct {
// preserves the current validation behavior.
type ValidationSpec struct {
// SharedFiles adds repository-relative committed files to optional file
// checks. Nil selects the optional defaults; an empty non-nil slice selects
// none. Explicit files are checked for presence even when file checks are off.
// checks. Nil selects the optional root COPYRIGHT, LICENSE, and
// docs/oss/attribution.md defaults; an empty non-nil slice selects none.
// Explicit files replace the defaults and must exist even when file checks
// are off.
SharedFiles []string
Go GoValidationSpec
// GoFormat checks the formatting of committed regular Go source files. It