Documentation
¶
Overview ¶
Package conform certifies a Githome instance against the compatibility matrix. It is a black-box client: it speaks only HTTP and reads only the wire shapes, so it certifies any Githome build the same way a real client would see it — whether the instance is a remote origin or an in-process test server. The githome-conform command is a thin CLI over Run; the in-process gate test drives the same Run against a freshly seeded server, so the matrix runs in CI without a live instance or real credentials.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Options ¶
type Options struct {
// API is the REST base, e.g. https://git.example.com/api/v3.
API string
// GraphQL is the GraphQL endpoint, e.g. https://git.example.com/api/graphql.
GraphQL string
// Token authenticates the client; it may be empty for an anonymous run.
Token string
// Owner and Repo name the target repository the matrix reads.
Owner string
Repo string
// HTTP is the client used for every request; Run supplies a default when nil.
HTTP *http.Client
}
Options points the matrix at one instance and target repository.
type Report ¶
type Report struct {
// contains filtered or unexported fields
}
Report collects the matrix outcome.
func Run ¶
Run executes the full conformance matrix against the instance Options names and returns the report. It never returns an error: a transport or shape failure is recorded as a failed row so the report stays the single verdict.
func (*Report) CountFailed ¶
CountFailed returns the number of failed checks.
func (*Report) Failures ¶
Failures returns a one-line "section/check: detail" string for each failed check, so a caller (a test) can name exactly what diverged.
Source Files