Skip to content

Navigation Menu

Sign in
Sign up

docs: add a contributor guide page for CI and the merge queue - #5863

Merged
mbutrovich merged 2 commits into
apache:main from
andygrove:docs/merge-queue-contributor-guide
Sep 11, 2026
Merged

docs: add a contributor guide page for CI and the merge queue #5863
mbutrovich merged 2 commits into
apache:main from
andygrove:docs/merge-queue-contributor-guide

Conversation

@andygrove

@andygrove andygrove commented Sep 11, 2026
edited
Loading

Copy link
Copy Markdown
Member

Which issue does this PR close?

None. Documentation follow-up to #5843.

Rationale for this change

#5843 changes what contributors see on their pull requests: the macOS build, the benchmark check and the Spark 3.4/3.5/4.0 and Iceberg 1.8/1.9/1.10 suites move behind the merge queue, with run-* labels to opt a pull request back in. The workflows README explains the mechanics for whoever maintains CI, but there was nothing in the contributor guide that tells a contributor what runs where, which label to apply, or what to do when a queue run fails.

What changes are included in this PR?

A new Continuous Integration page under Testing in the contributor guide covering:

  • the PR tier and the queue tier, and why the Linux build is the one test job that still runs on push to main
  • the opt-in labels, when a change warrants one, and what a label run does and does not run
  • how a committer queues a merge and what GitHub does with it
  • how to find a queue failure, how to tell an infrastructure failure from a test failure, and how to reproduce a queue failure on the pull request by merging main and applying the suite's label
  • what to run locally before changing CI

The development guide's test-suite registration section now links to it, and no longer names pr_missing_suites.yml, which was folded into preflight some time ago.

How are these changes tested?

prettier --check on the changed Markdown. The page describes the state of CI after #5843 merges, so this PR should land after it. Marked draft until then.

🤖 Generated with Claude Code

Describe the PR and queue tiers, the labels that opt a pull request into
a queue-only suite and when to use them, how a committer queues a merge,
what a queue failure means and how to reproduce it on the pull request,
and what to run before changing CI itself. Link it from the development
guide's test-suite registration section, which also still named a
workflow file that no longer exists.
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01BtAqq4YJsk8uk42c7vHk8B 
@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Sep 11, 2026
andygrove marked this pull request as ready for review September 11, 2026 21:13

@mbutrovich mbutrovich left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thanks @andygrove!

andygrove reacted with thumbs up emoji
mbutrovich added this pull request to the merge queue Sep 11, 2026
Merged via the queue into apache:main with commit c369d04 Sep 11, 2026
18 checks passed
andygrove deleted the docs/merge-queue-contributor-guide branch September 11, 2026 22:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@mbutrovich mbutrovich mbutrovich approved these changes

Assignees

No one assigned

Labels

documentation Improvements or additions to documentation

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

AltStyle によって変換されたページ (->オリジナル) /