Documentation
¶
Overview ¶
Package ecosystem keeps ECOSYSTEM.md aligned with a machine-readable matrix.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CheckDocument ¶
CheckDocument verifies ECOSYSTEM.md marked sections match matrix.json.
func WriteDocumentSections ¶
WriteDocumentSections rewrites the marked sections in ECOSYSTEM.md from matrix.json.
Types ¶
type CanaryTarget ¶
CanaryTarget is a public pinned ref checked by the live canary.
type Matrix ¶
type Matrix struct {
AsOf string `json:"as_of"`
Disclaimer string `json:"disclaimer"`
Roles []Role `json:"roles"`
SpannerplanVersions map[string]string `json:"spannerplan_versions"`
Observed []Observed `json:"observed"`
}
Matrix is the machine-readable source of truth for ECOSYSTEM.md tables.
func LoadMatrix ¶
LoadMatrix reads ecosystem/matrix.json from dir (repository root or ecosystem/).
func (*Matrix) CanaryTargets ¶
func (m *Matrix) CanaryTargets() []CanaryTarget
CanaryTargets derives the live integrity checks from the observed rows. This keeps the rendered matrix and the network check on one source of truth.
func (*Matrix) RenderObservedTable ¶
RenderObservedTable renders the observed-pins markdown table.
func (*Matrix) RenderRolesTable ¶
RenderRolesTable renders the markdown roles table body (with header).
type ModuleRequire ¶
ModuleRequire is a declared Go module require.
type Observed ¶
type Observed struct {
Consumer string `json:"consumer"`
ConsumerRef string `json:"consumer_ref"`
Kind string `json:"kind"`
Canary bool `json:"canary,omitempty"`
Repo string `json:"repo,omitempty"`
Path string `json:"path,omitempty"`
Requires []ModuleRequire `json:"requires,omitempty"`
ParityGoInstall string `json:"parity_go_install,omitempty"`
FixtureSyncRef string `json:"fixture_sync_ref,omitempty"`
LatestPublishedRelease string `json:"latest_published_release,omitempty"`
Notes string `json:"notes,omitempty"`
}
Observed records an observed pin without implying compatibility.
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
canary
command
Command canary checks the integrity of public consumer go.mod pins recorded in ecosystem/matrix.json.
|
Command canary checks the integrity of public consumer go.mod pins recorded in ecosystem/matrix.json. |
|
render
command
Command render rewrites ECOSYSTEM.md marked sections from ecosystem/matrix.json.
|
Command render rewrites ECOSYSTEM.md marked sections from ecosystem/matrix.json. |