supportmatrix

package

v1.0.0-rc.1 Latest Latest Go to latest Published: Jul 29, 2026 License: Apache-2.0 Imports: 12 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/marang/robotgo

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func RenderMarkdown(contract Contract) string
func ReplaceMarkdown(document string, rendered string) (string, error)
type Contract
- func Load(path string) (Contract, error)
- func (contract Contract) Validate() error
type Row

Constants ¶

View Source

const (
	// SchemaVersion is the only support-contract schema understood by this package.
	SchemaVersion = 1

	// StatusSupported identifies a scope backed by release-blocking evidence.
	StatusSupported = "supported"
	// StatusEvidencePending identifies implemented behavior that is not in the
	// supported release scope because required runtime evidence is missing.
	StatusEvidencePending = "implemented_evidence_pending"
	// StatusNotClaimed identifies a scope for which the release makes no support claim.
	StatusNotClaimed = "not_claimed"
)

View Source

const (
	MarkdownStart = "<!-- BEGIN GENERATED RUNTIME SUPPORT MATRIX -->"
	MarkdownEnd   = "<!-- END GENERATED RUNTIME SUPPORT MATRIX -->"
)

MarkdownStart and MarkdownEnd delimit the generated compatibility table.

Variables ¶

This section is empty.

Functions ¶

func RenderMarkdown ¶

func RenderMarkdown(contract Contract) string

RenderMarkdown renders the human-readable table from the checked contract.

func ReplaceMarkdown ¶

func ReplaceMarkdown(document string, rendered string) (string, error)

ReplaceMarkdown replaces exactly one generated support-matrix block.

Types ¶

type Contract ¶

type Contract struct {
	SchemaVersion int      `json:"schemaVersion"`
	Published     string   `json:"published"`
	ReleaseRun    string   `json:"releaseRun"`
	ReleaseCommit string   `json:"releaseCommit"`
	ReleaseChecks []string `json:"releaseChecks"`
	Rows          []Row    `json:"rows"`
}

Contract is the machine-readable source for Runtime Compatibility Matrix v1.

func Load ¶

func Load(path string) (Contract, error)

Load reads and validates one support contract.

func (Contract) Validate ¶

func (contract Contract) Validate() error

Validate enforces the support-state and release-evidence contract.

type Row ¶

type Row struct {
	ID              string   `json:"id"`
	Platform        string   `json:"platform"`
	BuildMode       string   `json:"buildMode"`
	Scope           string   `json:"scope"`
	Status          string   `json:"status"`
	BlockingChecks  []string `json:"blockingChecks,omitempty"`
	CurrentChecks   []string `json:"currentChecks,omitempty"`
	Limits          string   `json:"limits"`
	MissingEvidence string   `json:"missingEvidence,omitempty"`
	FollowUp        string   `json:"followUp,omitempty"`
}

Row describes one deliberately bounded platform and build-mode support claim.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL