Skip to content

docs(ci-insights): add runners + setup screenshots, refresh stale ones#12144

Merged
mergify[bot] merged 1 commit into
mainfrom
devs/jd/jd/ci-insights/add-runners-setup-screenshots-refresh-stale-ones--45beefd7
Jul 21, 2026
Merged

docs(ci-insights): add runners + setup screenshots, refresh stale ones#12144
mergify[bot] merged 1 commit into
mainfrom
devs/jd/jd/ci-insights/add-runners-setup-screenshots-refresh-stale-ones--45beefd7

Conversation

@jd

@jd jd commented Jul 17, 2026

Copy link
Copy Markdown
Member

Part 2 (CI Insights) of the docs screenshot refresh.

New screenshots:

  • runners.mdx: add the self-hosted runners Fleet view (success rate, capacity,
    utilization, and the per-runner health table).
  • setup/github-actions.mdx: wire the CI Insights token screen and the GitHub
    Actions secret screen into the MERGIFY_TOKEN setup step (both images already
    existed on disk, unimported).

Refreshed stale dashboard screenshots against the redesigned CI Insights UI:

  • jobs.png (shared by 4 setup pages): old nav order, "CI Insights BETA" badge,
    and a removed "Tests" nav item -> current layout.
  • auto-retry/rule.png: recaptured; the old shot predates the new "Retry mode"
    field and updated description.

Freshness-verified and kept as-is (external tooling UIs, still current):
buildkite-webhook-notification.png, jenkins-installation.png,
jenkins-configuration.png.

Build: pnpm build green (373 pages).

Refs MRGFY-8060

Copilot AI review requested due to automatic review settings July 17, 2026 18:44
@mergify
mergify Bot had a problem deploying to Mergify Merge Protections July 17, 2026 18:44 Failure
@mergify

mergify Bot commented Jul 17, 2026

Copy link
Copy Markdown
Contributor

Merge Protections

🟢 All 6 merge protections satisfied — ready to merge.

Show 6 satisfied protections

🟢 🤖 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]
    • author = mergify-ci-bot

🟢 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.

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

Updates CI Insights documentation pages to include missing/updated dashboard screenshots, aligning the docs with the redesigned CI Insights UI and making key setup steps more visual.

Changes:

  • Added CI Insights token and GitHub Actions secret screenshots to the GitHub Actions setup guide.
  • Added the self-hosted runners “Fleet” view screenshot to the runners overview page.

Reviewed changes

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

File Description
src/content/docs/ci-insights/setup/github-actions.mdx Imports and renders token + GitHub secrets screenshots in the MERGIFY_TOKEN setup step.
src/content/docs/ci-insights/runners.mdx Adds an astro:assets image import and renders the runners fleet view screenshot.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread src/content/docs/ci-insights/setup/github-actions.mdx Outdated
Comment thread src/content/docs/ci-insights/setup/github-actions.mdx Outdated
@mergify
mergify Bot requested a review from a team July 17, 2026 18:47
@jd

jd commented Jul 17, 2026

Copy link
Copy Markdown
Member Author

Heads-up: the 3rd ADD (flaky-test-detection.mdx) needs a product/docs call

The audit split asked to capture a "CI Insights → Tests view with flagged flaky tests" for
ci-insights/flaky-test-detection.mdx. Verifying live against dashboard.mergify.com, the premise
doesn't hold, so I intentionally left that page out of this PR rather than guess:

  • There is no "Tests" view in CI Insights. The CI Insights nav is now Jobs · Job Executions ·
    Auto-retry · Issues · Self-hosted Runners
    (/ci-insights/tests → 404). The page's prose
    "CI Insights Dashboard → Tests View" is itself inaccurate.
  • Flaky tests live under Test Insights → Detection — the flaky/broken/healthy list, already
    captured in docs(test-insights): add Detection, Prevention, Mitigation screenshots #12127 (detection.png on test-insights/detection.mdx).
  • monorepo currently has 0 flaky tests (Detection shows the empty state), so a populated
    flaky-test list can't be captured right now.

Options (pick one and I'll fold it into this PR before merge):

  • A (my recommendation): skip the embed; keep the DocsetGrid setup links and add a pointer to
    Test Insights → Detection for the live flaky list. Also corrects the "CI Insights → Tests" prose.
  • B: embed the Test Insights → Detection overview (donut + CI Impact + Flaky/Broken/Healthy tabs,
    even with 0 flaky) and relabel the prose to "Test Insights → Detection". Duplicates docs(test-insights): add Detection, Prevention, Mitigation screenshots #12127's view.
  • C: wait until monorepo has flaky tests, then capture a populated list and embed it.

Everything else in Part 2 (runners fleet, github-actions token+secrets wiring, and the 5 freshness
checks — jobs.png and auto-retry/rule.png were stale and redone) is in this PR and CI is green.

Part 2 (CI Insights) of the docs screenshot refresh.

New screenshots:
- runners.mdx: add the self-hosted runners Fleet view (success rate, capacity,
  utilization, and the per-runner health table).
- setup/github-actions.mdx: wire the CI Insights token screen and the GitHub
  Actions secret screen into the MERGIFY_TOKEN setup step (both images already
  existed on disk, unimported).

Refreshed stale dashboard screenshots against the redesigned CI Insights UI:
- jobs.png (shared by 4 setup pages): old nav order, "CI Insights BETA" badge,
  and a removed "Tests" nav item -> current layout.
- auto-retry/rule.png: recaptured; the old shot predates the new "Retry mode"
  field and updated description.

Freshness-verified and kept as-is (external tooling UIs, still current):
buildkite-webhook-notification.png, jenkins-installation.png,
jenkins-configuration.png.

Build: pnpm build green (373 pages).

Refs MRGFY-8060

Change-Id: I45beefd70ca8212997d0e469167dc2c0f9f13d5b
@jd
jd force-pushed the devs/jd/jd/ci-insights/add-runners-setup-screenshots-refresh-stale-ones--45beefd7 branch from 27fa669 to fc38d36 Compare July 20, 2026 07:54
@jd

jd commented Jul 20, 2026

Copy link
Copy Markdown
Member Author

Revision history

# Type Changes Reason Date
1 initial 27fa669 2026-07-20 07:54 UTC
2 content 27fa669 → fc38d36 (raw) 2026-07-20 07:54 UTC

@mergify
mergify Bot deployed to Mergify Merge Protections July 20, 2026 07:54 Active
@jd
jd marked this pull request as ready for review July 21, 2026 10:44
@mergify
mergify Bot requested a review from a team July 21, 2026 12:07
@mergify mergify Bot added the queued label Jul 21, 2026
@mergify

mergify Bot commented Jul 21, 2026

Copy link
Copy Markdown
Contributor

Merge Queue Status

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

Required conditions to merge

@mergify
mergify Bot merged commit b9cc353 into main Jul 21, 2026
9 of 15 checks passed
@mergify
mergify Bot deleted the devs/jd/jd/ci-insights/add-runners-setup-screenshots-refresh-stale-ones--45beefd7 branch July 21, 2026 13:16
@mergify mergify Bot removed the queued label Jul 21, 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