Skip to content

docs: reflect shipped release audit schema - #1034

Merged
potiuk merged 1 commit into
apache:mainfrom
Cirque-Du-Trash:docs/update-release-audit-schema-gap
Jul 30, 2026
Merged

docs: reflect shipped release audit schema#1034
potiuk merged 1 commit into
apache:mainfrom
Cirque-Du-Trash:docs/update-release-audit-schema-gap

Conversation

@Cirque-Du-Trash

Copy link
Copy Markdown
Contributor

Summary

  • Replace the stale claim that the release audit record schema is prose-only.
  • Point the spec loop at the shipped canonical schema and the incomplete-record eval fixture so it does not plan already-completed work.

Type of change

  • Other: spec documentation

Test plan

  • uv run --project tools/spec-validator spec-validate tools/spec-loop/specs/
  • Applicable prek hooks for tools/spec-loop/specs/release-management-lifecycle.md (including markdownlint, typos, lychee, placeholder checks, and spec validation)
  • prek run --all-files — Windows path separators and materialized symlinks trigger unrelated repository-wide archive/workspace checks; the checks applicable to this one-file change pass.

RFC-AI-0004 compliance

No runtime behaviour or state-changing workflow is changed.

Linked issues

Closes #936

Generative AI disclosure

This change was prepared with Codex (GPT-5). The commit records this with a Generated-by: trailer and does not use an AI Co-Authored-By: trailer.

Generated-by: Codex (GPT-5)
@Cirque-Du-Trash
Cirque-Du-Trash marked this pull request as ready for review July 29, 2026 11:45

@potiuk potiuk left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM — the gap really is closed, and the replacement text is accurate. I checked each of the three claims against the tree:

  • skills/release-audit-report/audit-record-schema.md exists and is the structured schema the old bullet said was missing.
  • tools/skill-evals/evals/release-audit-report/ exists as a full suite (step-0-preflight, step-1-gather-record, step-2-assemble-record).
  • case-4-all-required-missing exists under step-2-assemble-record/fixtures/ and is genuinely an incomplete-record fixture — every required field after version / planning_issue_url is MISSING. case-2-missing-fields covers the partial case alongside it, so "validates incomplete records" is a fair description of the suite.

Rewriting the bullet in place rather than deleting it is also the right call for this file: the first entry under ## Known gaps already uses exactly this shape ("All ten skills have shipped — …"), so a resolved gap stays visible as a record instead of silently disappearing from the list.

Thanks for the first contribution to Apache Magpie — this is the kind of spec-drift fix that is easy to miss and annoying to discover later.


This review was drafted by an AI-assisted tool and
confirmed by an Apache Magpie maintainer. The maintainer
approving this PR has read the findings and signed off. If
something feels off, please reply on the PR and a maintainer
will follow up.

More on how Apache Magpie handles maintainer review:
CONTRIBUTING.md § Opening a pull request.

@potiuk
potiuk merged commit 3cde9e6 into apache:main Jul 30, 2026
9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Update release-management-lifecycle.md: the audit record schema has shipped

2 participants