bench-xref

Syncs benchmark cross-reference blocks onto GitHub issue bodies via the xref CLI.

611|63|Updated Sep 26, 2017
One-click install
npx skills add https://github.com/markuplint/markuplint --skill bench-xref
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: bench-xref
Source: https://github.com/markuplint/markuplint/tree/main/.claude/skills/bench-xref
Command: npx skills add https://github.com/markuplint/markuplint --skill bench-xref

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Keeping GitHub issue bodies in sync with benchmark fixture results is manual and error-prone; this Skill automates generating and updating the bench-xref marker blocks that list matching fixtures and verdict tallies on configured issues.

Core Features & Use Cases

  • Issue body sync: Runs yarn bench:xref with --issue, --all, --dry-run, and --write flags to preview and apply idempotent marker block updates.
  • Mapping management: Maintains primary, secondary, and bodyOverride entries in tests/external/bench/issue-xref.config.ts as issues open, close, or shift scope.
  • Pre-release audit: Runs yarn bench:xref --audit to prune CLOSED issues before cutting a release, backed by the bench-xref-audit CI workflow.
  • Use Case: After regenerating benchmark coverage with yarn bench:update, dry-run the xref sync, review the diffs, then write the updated blocks to all mapped GitHub issues.

Quick Start

Run a dry-run of the bench xref sync across all configured issues and show me the intended diffs before applying them.

Frequently Asked Questions about bench-xref

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I sync benchmark results to GitHub issue bodies?

Run `yarn bench:xref --all --dry-run --write` to review intended diffs, then `yarn bench:xref --all --write` to apply them. The generated marker block is idempotent and only updates when underlying fixture numbers change.

How do I add a new issue mapping to the bench xref config?

Add a `primary` mapping with a focused `filter` in `tests/external/bench/issue-xref.config.ts` when fixtures match the issue, or a `secondary` mapping with a `reason` when none match. Confirm with `yarn bench:xref --issue <N>`.

What happens when a mapped GitHub issue closes?

Remove the entry from issue-xref.config.ts; the umbrella block auto-derives from remaining primary mappings. The `bench-xref-audit` CI workflow exits non-zero on CLOSED entries, blocking PR merges until removal.

Does the bench xref CLI make network calls on every run?

No. Without the `--write` flag, output goes to stdout and no network call is made. Writing to issue bodies requires the `gh` CLI installed and authenticated.

How do I change the bench-xref marker block format version?

Bump BEGIN_MARKER and END_MARKER in xref-issue.ts, temporarily widen the composeBody regex to accept both versions, run `yarn bench:xref --all --write` once, then drop the old version from the regex.