Documentation
¶
Overview ¶
Package maintainerconfig defines the single schema of the per-repo `.maintainer.yaml` trust file shared by all maintainer bots, plus a pure parser. Each top-level key is one bot's namespace:
release: autoRelease: true # github-release watcher gate prReviewer: autoApprove: true # pr-reviewer agent gate goUpdate: autoUpdate: true # github-update-go-watcher gate
Adding the next bot (build-fix, dep-pin, …) is a one-field edit to MaintainerConfig — every consumer imports this one type, so there is never a divergent copy of the file's shape.
Unknown fields (top-level OR nested) are REJECTED at parse time (yaml.NewDecoder + KnownFields(true)). This catches typos like `changelogRwrite` or `prRevierer` that would otherwise produce a silent default-false config — a high-trust .maintainer.yaml is load-bearing for release gating, so a typo must fail loudly. To add a new bot's namespace, extend MaintainerConfig with the new field FIRST (one PR), then deploy the bot (next PR); the brief window between the two is the only time a forward-incompat .maintainer.yaml would error, and it errors loudly rather than silently downgrading.
Parse does NO I/O — fetching the bytes is each consumer's job (the watcher fetches via the GitHub API; the agent reads the cloned workDir on disk).
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type GoUpdateConfig ¶ added in v0.48.1
type GoUpdateConfig struct {
AutoUpdate bool `yaml:"autoUpdate"`
}
GoUpdateConfig is the `goUpdate:` namespace. AutoUpdate=true is the per-repo consent flag the github-update-go-watcher gates on before opening a Go-version-bump PR — the same trust-gate shape as ReleaseConfig.AutoRelease. A repo with no `.maintainer.yaml`, no `goUpdate:` block, or `autoUpdate` absent/false all read as false (opt-in, not opt-out).
type MaintainerConfig ¶
type MaintainerConfig struct {
// Release is the github-release watcher namespace.
Release ReleaseConfig `yaml:"release"`
// PrReviewer is the pr-reviewer agent namespace.
PrReviewer PrReviewerConfig `yaml:"prReviewer"`
// GoUpdate is the github-update-go-watcher namespace.
GoUpdate GoUpdateConfig `yaml:"goUpdate"`
}
MaintainerConfig is the parsed shape of `.maintainer.yaml`. Each field is one bot's namespace; siblings are independent. A consumer reads only its own namespace and ignores the rest.
func Parse ¶
func Parse(ctx context.Context, content []byte) (MaintainerConfig, error)
Parse unmarshals a `.maintainer.yaml` document leniently (unknown fields are silently ignored). Pure data extraction — no I/O. Empty input returns a zero-value MaintainerConfig with nil error. Malformed YAML returns a wrapped error (NOT a silent zero-value) so callers can fail loudly.
Fleet-tolerant by design: the github-release watcher reads `.maintainer.yaml` from every repo to gate auto-release, and a typo'd key in one repo must NOT break the watcher for the rest of the fleet. Use ParseStrict instead when the caller wants typos to fail closed (e.g. the github-releaser planning step — see spec 059).
func ParseStrict ¶
func ParseStrict(ctx context.Context, content []byte) (MaintainerConfig, error)
ParseStrict unmarshals a `.maintainer.yaml` document with `KnownFields(true)` so any unrecognized top-level or nested key produces a wrapped error. Use this when the caller wants typos like `changelogRwrite` to fail loudly (e.g. the github-releaser planning step where a silent zero-value would disable the rewrite pipeline without operator signal).
The lib's lenient Parse remains the default for fleet readers (watcher).
type PrReviewerConfig ¶
type PrReviewerConfig struct {
AutoApprove bool `yaml:"autoApprove"`
}
PrReviewerConfig is the `prReviewer:` namespace. AutoApprove=true means "post an approving review on an approve verdict"; absence/false means comment-only.
type ReleaseConfig ¶
type ReleaseConfig struct {
AutoRelease bool `yaml:"autoRelease"`
ChangelogRewrite bool `yaml:"changelogRewrite"`
AllowMajorBump bool `yaml:"allowMajorBump"`
// AllowFork opts a forked repo into auto-release eligibility. See the
// field-group doc comment above for why this defaults closed.
AllowFork bool `yaml:"allowFork"`
}
ReleaseConfig is the `release:` namespace. AutoRelease=true is the ONLY shape that lets the github-release watcher emit a release task; everything else (key absent, value false, file absent) skips the repo.
ChangelogRewrite is the spec-059 per-repo opt-in flag for the 058 LLM rewrite pipeline. Default false (omit the field, set false explicitly, or omit the `release:` block — all equivalent). When true, planning invokes the 058 rewrite classification; when false (or absent), planning short-circuits with `rewrite_needed=false` regardless of ## Unreleased content — preserving the pre-058 header-rename-only behavior fleet-wide. Non-boolean values fail at parse time; the planning step is responsible for surfacing the error as `error_category=invalid_config`. See spec 059 § Desired Behavior 1-3 and § Goal.
AllowMajorBump is the spec-060 per-repo opt-in for automatic major-version releases. Default false (omit the field, set false explicitly, or omit the `release:` block — all equivalent). When false, the github-releaser-agent planning phase TRIPS (Status=NeedsInput, ## Plan outcome=needs_input, precondition_failed=major_bump_not_allowed) on any classifier verdict of `bump=major`, forcing a human ack before tag + push. When true, a major verdict proceeds to execution as before. The second lever is the `--allow-major` CLI flag (env `ALLOW_MAJOR`) — either source is sufficient. Non-boolean values fail at parse time; the planning step is responsible for surfacing the error as `error_category=invalid_config`. See spec 060 § Desired Behavior 1 and § Goal.
AllowFork only has meaning when the repo carrying this config is itself a fork. The github-release-watcher currently drops forked repos during repo listing, upstream of this config being read at all, so a fork with `autoRelease: true` never releases. AllowFork is the fix's per-repo half: once the watcher stops filtering forks, it will additionally require AllowFork=true before treating a fork as release-eligible. Default false (field absent, or `.maintainer.yaml` absent) so a `.maintainer.yaml` INHERITED from forking a repo that already sets `autoRelease: true` does not silently start auto-tagging the fork — the fork owner must opt in explicitly. Non-boolean values fail at parse time like the other fields.
Source Files