Skip to content

fix(test-insights): stop pinning the Buildkite plugin to its first release - #12426

Merged
mergify[bot] merged 2 commits into
mainfrom
devs/jd/jd/mrgfy-8720-settle-four-docs-asks-the-agent-could-not-bypass-anchor-ci/stop-pinning-buildkite-plugin-first-release--c5504d66
Aug 24, 2026
Merged

fix(test-insights): stop pinning the Buildkite plugin to its first release#12426
mergify[bot] merged 2 commits into
mainfrom
devs/jd/jd/mrgfy-8720-settle-four-docs-asks-the-agent-could-not-bypass-anchor-ci/stop-pinning-buildkite-plugin-first-release--c5504d66

Conversation

@jd

@jd jd commented Aug 18, 2026

Copy link
Copy Markdown
Member

The two Buildkite upload snippets hardcode mergifyio/mergify-ci#v1 in their
.astro source. v1 is the oldest of six releases — v1 through v6 are
distinct tags, not a floating major — so every reader who copies one of these
snippets pins the first version ever cut and never receives anything shipped
since.

Nothing else in the docs does this. Every Buildkite page writes
@@BUILDKITE_PLUGIN_VERSION@@, which plugins/remark-buildkite-version.ts
substitutes from src/data/buildkite-plugin-version.json at build time. That
plugin only visits markdown nodes, so the sentinel does nothing inside an
.astro component and these two were left pinning by hand. The fix is the one
the GitHub Actions counterpart already uses: import the data file and
interpolate it, exactly as MergifyCIUploadStepMatrix.astro does with
gha-mergify-ci-version.json.

Bumping v1 to v6 would have recreated the same problem one release later.

This matters now because the commit at the bottom of this stack recommends the
plugin's job_name property again. A reader who copies the matrix snippet and
pins v1 gets a plugin where that property predates the code reading it — the
docs would recommend a knob that is dead in the version the snippet installs.

The non-matrix component has the same pin and is the more widely used of the
two: eleven test-framework recipes render it. Both are fixed here, since it is
one bug with one cause.

Verified on the built output: all 78 rendered occurrences of the plugin
reference now read v6, none read v1, and no template literal leaked into
the HTML. pnpm check 0 errors, pnpm build 384 pages, pnpm test 144
passed, pnpm check:internal-leaks clean.

Refs MRGFY-8720

Depends-On: #12417

@jd

jd commented Aug 18, 2026

Copy link
Copy Markdown
Member Author

This pull request is part of a Mergify stack:

# Pull Request Link
1 fix(test-insights): point the framework recipes at a dashboard page that exists #12417
2 fix(test-insights): stop pinning the Buildkite plugin to its first release #12426 👈

@mergify

mergify Bot commented Aug 18, 2026

Copy link
Copy Markdown
Contributor

Merge Protections

🟢 All 7 merge protections satisfied — ready to merge.

Show 7 satisfied protections

🟢 ⛓️ Depends-On Requirements

Requirement based on the presence of Depends-On in the body of the pull request

🟢 🤖 Continuous Integration

  • all of:
    • check-success = build
    • check-success = lint
    • check-success = test
    • any of:
      • check-success = test-broken-links
      • label = ignore-broken-links
    • any of:
      • check-success=Cloudflare Pages
      • -head-repo-full-name~=^Mergifyio/

🟢 👀 Review Requirements

  • any of:
    • #approved-reviews-by >= 2
    • author = dependabot[bot]
    • all of:
      • author = mergify-ci-bot
      • -head ~= ^docs-agent/

🟢 Enforce conventional commit

Make sure that we follow https://www.conventionalcommits.org/en/v1.0.0/

  • title ~= ^(fix|feat|internal|docs|style|refactor|perf|test|build|ci|chore|revert|ui)(?:\(.+\))?!?:

🟢 🔎 Reviews

  • #changes-requested-reviews-by = 0
  • #review-requested = 0
  • #review-threads-unresolved = 0

🟢 📕 PR description

  • body ~= (?ms:.{48,})

🟢 🚦 Auto-queue

When all merge protections are satisfied, this pull request will be queued automatically.

@mergify
mergify Bot requested a review from a team August 18, 2026 07:37
@jd
jd marked this pull request as ready for review August 18, 2026 09:07
Copilot AI lite review requested due to automatic review settings August 18, 2026 09:07

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Pull request overview

This PR fixes the Buildkite plugin version used in the Test Insights upload snippets by removing the hardcoded #v1 pin and instead sourcing the version from src/data/buildkite-plugin-version.json, matching how markdown snippets already get the version substituted at build time.

Changes:

  • Import ~/data/buildkite-plugin-version.json in the two affected .astro components.
  • Interpolate buildkitePluginVersion.version into the Buildkite plugin reference so the rendered docs track the configured version (currently v6).

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

File Description
src/components/BuildkiteCIUploadStepMatrix.astro Replaces hardcoded #v1 with an interpolated version from the shared JSON data source.
src/components/BuildkiteCIUploadStep.astro Replaces hardcoded #v1 with an interpolated version from the shared JSON data source.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

@jd
jd force-pushed the devs/jd/jd/mrgfy-8720-settle-four-docs-asks-the-agent-could-not-bypass-anchor-ci/stop-pinning-buildkite-plugin-first-release--c5504d66 branch from 479ee49 to 86c9072 Compare August 21, 2026 15:09
@jd

jd commented Aug 21, 2026

Copy link
Copy Markdown
Member Author

Revision history

# Type Changes Reason Date
1 initial 479ee49 2026-08-21 15:09 UTC
2 rebase 479ee49 → 86c9072 (rebase only) 2026-08-21 15:09 UTC
3 rebase 86c9072 → f03d9da (rebase only) restacked onto the rebased base; content unchanged 2026-08-24 08:33 UTC

@mergify
mergify Bot had a problem deploying to Mergify Merge Protections August 21, 2026 15:10 Failure
@jd

jd commented Aug 21, 2026

Copy link
Copy Markdown
Member Author

Restacked only — 479ee4986c9072 (compare). The content of this commit is unchanged; it moved because the base #12417 was rebased onto main.

jd added 2 commits August 24, 2026 10:31
Every test framework recipe ends by sending the reader to the Test Insights
dashboard, and each one carried its own copy of that sentence. Ten of the copies
had drifted onto `https://dashboard.mergify.com/test-insights/jobs`, which is not
a page — Test Insights has Prevention, Detection and Mitigation — and an
eleventh named the dashboard with no link at all. #12490 has since corrected all
eleven in place, so the links work today; what it could not fix is why one stale
URL became ten broken links, which is that the sentence exists eleven times.

So the paragraph becomes `_review-in-test-insights.mdx`, included by the
recipes. The rendered text is byte-identical to what #12490 shipped; the next
time that link moves it is one edit rather than eleven, and a recipe cannot
quietly drift out of step with its siblings again. Shared partials are already
how these files handle the Buildkite quarantine setup and the upload steps.

Separately, two inline GitHub Actions examples were missing the
`continue-on-error: true` that the quarantine partial they include requires:
the Gradle example in the JUnit recipe and the `rake test` example in the
Minitest one. Without it a failing test step ends the job before the upload step
runs, so the run that most needs a report produces none — and in both files the
sibling example directly above already had the line, so this was drift rather
than a deliberate difference.

Part of MRGFY-8720

Change-Id: I482ec81d7710f37d83dcffdf65abc029b73437fc
…lease

The two Buildkite upload snippets hardcode `mergifyio/mergify-ci#v1` in their
`.astro` source. `v1` is the oldest of six releases — `v1` through `v6` are
distinct tags, not a floating major — so every reader who copies one of these
snippets pins the first version ever cut and never receives anything shipped
since.

Nothing else in the docs does this. Every Buildkite page writes
`@@BUILDKITE_PLUGIN_VERSION@@`, which `plugins/remark-buildkite-version.ts`
substitutes from `src/data/buildkite-plugin-version.json` at build time. That
plugin only visits markdown nodes, so the sentinel does nothing inside an
`.astro` component and these two were left pinning by hand. The fix is the one
the GitHub Actions counterpart already uses: import the data file and
interpolate it, exactly as `MergifyCIUploadStepMatrix.astro` does with
`gha-mergify-ci-version.json`.

Bumping `v1` to `v6` would have recreated the same problem one release later.

This matters now because the commit at the bottom of this stack recommends the
plugin's `job_name` property again. A reader who copies the matrix snippet and
pins `v1` gets a plugin where that property predates the code reading it — the
docs would recommend a knob that is dead in the version the snippet installs.

The non-matrix component has the same pin and is the more widely used of the
two: eleven test-framework recipes render it. Both are fixed here, since it is
one bug with one cause.

Verified on the built output: all 78 rendered occurrences of the plugin
reference now read `v6`, none read `v1`, and no template literal leaked into
the HTML. `pnpm check` 0 errors, `pnpm build` 384 pages, `pnpm test` 144
passed, `pnpm check:internal-leaks` clean.

Refs MRGFY-8720

Change-Id: Ic5504d661f0c14e668fbb7b8cf55cf86b9dd5788
@jd
jd force-pushed the devs/jd/jd/mrgfy-8720-settle-four-docs-asks-the-agent-could-not-bypass-anchor-ci/stop-pinning-buildkite-plugin-first-release--c5504d66 branch from 86c9072 to f03d9da Compare August 24, 2026 08:33
@jd

jd commented Aug 24, 2026

Copy link
Copy Markdown
Member Author

Restacked only — 86c9072f03d9da (compare). The content of this commit is unchanged; it moved because the base (#12417) was rebased onto main after #12490 landed.

@mergify
mergify Bot deployed to Mergify Merge Protections August 24, 2026 08:34 Active
Base automatically changed from devs/jd/jd/mrgfy-8720-settle-four-docs-asks-the-agent-could-not-bypass-anchor-ci/point-framework-recipes-dashboard-page-exists--482ec81d to main August 24, 2026 11:55
@mergify
mergify Bot requested a review from a team August 24, 2026 12:13
@mergify

mergify Bot commented Aug 24, 2026

Copy link
Copy Markdown
Contributor

Merge Queue Status

This pull request spent 3 minutes 21 seconds in the queue, including 2 minutes 45 seconds running CI.

Required conditions to merge

@mergify mergify Bot added the queued label Aug 24, 2026
@mergify
mergify Bot merged commit dc5a47c into main Aug 24, 2026
10 of 17 checks passed
@mergify
mergify Bot deleted the devs/jd/jd/mrgfy-8720-settle-four-docs-asks-the-agent-could-not-bypass-anchor-ci/stop-pinning-buildkite-plugin-first-release--c5504d66 branch August 24, 2026 12:30
@mergify mergify Bot removed the queued label Aug 24, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

4 participants