Documentation
¶
Overview ¶
Package qualityrun composes quality mechanisms, selection and durable reports. It does not depend on CLI commands or contracts.
Index ¶
- func Baseline(_ context.Context, request BaselineRequest) error
- func CheckNames(checks []quality.Check) []string
- func CoverageMarkdown(report quality.CoverageReport) string
- func PersistChanged(report ChangedReport, reportDir string) error
- func PersistVerification(report VerificationIndex, reportDir, name string) error
- func Summary(_ context.Context, request SummaryRequest) error
- func VerificationMarkdown(report VerificationIndex) string
- func Worklist(_ context.Context, request WorklistRequest) (quality.Worklist, error)
- func WorklistText(worklist quality.Worklist) string
- type ArtifactReference
- type BaselineRequest
- type ChangedReport
- type ChangedRequest
- type ChangedResult
- type CoverageArtifacts
- type CoverageRequest
- type CoverageResult
- type GitState
- type Observer
- type StoredRequest
- type StoredResult
- type SummaryRequest
- type VerificationIndex
- type VerificationRequest
- type VerificationResult
- type WorklistRequest
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CheckNames ¶
func CoverageMarkdown ¶
func CoverageMarkdown(report quality.CoverageReport) string
func PersistChanged ¶
func PersistChanged(report ChangedReport, reportDir string) error
func PersistVerification ¶
func PersistVerification(report VerificationIndex, reportDir, name string) error
func VerificationMarkdown ¶
func VerificationMarkdown(report VerificationIndex) string
func WorklistText ¶
Types ¶
type ArtifactReference ¶
type BaselineRequest ¶
type ChangedReport ¶
type ChangedReport struct {
ScopeIdentity *quality.CoverageScopeIdentity `yaml:"scope_identity,omitempty" json:"scope_identity,omitempty"`
ScopeReason string `yaml:"scope_reason,omitempty" json:"scope_reason,omitempty"`
ChangedScope []string `yaml:"changed_scope,omitempty" json:"changed_scope,omitempty"`
Scope []string `yaml:"scope,omitempty" json:"scope,omitempty"`
MergeBase string `yaml:"merge_base" json:"merge_base"`
Target string `yaml:"target" json:"target"`
Packages []quality.PackageRatchet `yaml:"packages" json:"packages"`
// Warnings are count rises in packages the PR did not itself change
// (founder decision 2026-09-23, review B1): reported, never failed on.
Warnings []quality.RatchetWarning `yaml:"warnings" json:"warnings"`
// RedBase is set when the merge base was measured while its own tests
// were failing: the ratchet still ran, against an upper-bound baseline.
RedBase *quality.RedBaseline `yaml:"red_base,omitempty" json:"red_base,omitempty"`
}
type ChangedRequest ¶
type ChangedRequest struct {
Path, Target, BaselineFile, ReportDir string
BaselineTimeout time.Duration
Run quality.RunOptions
AffectedPackages bool
Minimum float64
Diagnostics io.Writer
BeforePersist func(ChangedReport)
}
type ChangedResult ¶
type ChangedResult struct {
Report ChangedReport
HasReport bool
Findings string
}
func ChangedCoverage ¶
func ChangedCoverage(ctx context.Context, request ChangedRequest) (ChangedResult, error)
type CoverageArtifacts ¶
type CoverageArtifacts struct {
Report ArtifactReference
Diagnostics *ArtifactReference
}
func PersistCoverage ¶
func PersistCoverage(report quality.CoverageReport, reportDir string) (CoverageArtifacts, error)
type CoverageRequest ¶
type CoverageRequest struct {
Selection reposelection.Request
Run quality.RunOptions
Resume bool
ReportDir string
Observer Observer
}
type CoverageResult ¶
type CoverageResult struct {
Report quality.CoverageReport
NoWork bool
Artifacts CoverageArtifacts
}
func Coverage ¶
func Coverage(ctx context.Context, request CoverageRequest) (CoverageResult, error)
type StoredRequest ¶
type StoredResult ¶
type StoredResult struct {
Report quality.CoverageReport
Artifacts CoverageArtifacts
NoRecords bool
}
func StoredCoverage ¶
func StoredCoverage(ctx context.Context, request StoredRequest) (StoredResult, error)
type SummaryRequest ¶
type SummaryRequest struct {
Profile, Module, Out string
Meta quality.CoverageSummaryMeta
}
type VerificationIndex ¶
type VerificationIndex struct {
SchemaVersion int `yaml:"schema_version" json:"schema_version"`
GeneratedAt time.Time `yaml:"generated_at" json:"generated_at"`
Profile string `yaml:"profile,omitempty" json:"profile,omitempty"`
Checks []quality.Check `yaml:"checks" json:"checks"`
Repositories []quality.VerificationReport `yaml:"repositories" json:"repositories"`
}
type VerificationRequest ¶
type VerificationRequest struct {
Selection reposelection.Request
Run quality.RunOptions
Checks []quality.Check
Name, Profile, ReportDir string
Resume bool
Observer Observer
}
type VerificationResult ¶
type VerificationResult struct {
Report VerificationIndex
NoWork bool
}
func Verification ¶
func Verification(ctx context.Context, request VerificationRequest) (VerificationResult, error)
type WorklistRequest ¶
Click to show internal directories.
Click to hide internal directories.