Skip to content

Keep what contributors need about fork CI in the contributor docs - #77133

Merged
potiuk merged 4 commits into
apache:mainfrom
potiuk:fork-ci-docs-consolidate
Nov 15, 2026
Merged

potiuk merged 4 commits into
apache:mainfrom
potiuk:fork-ci-docs-consolidate

Conversation

@potiuk

@potiuk potiuk commented Nov 15, 2026 •

Copy link
Copy Markdown
Member

On the dev list, the fork CI (ADIP-12, formerly AIP-120) design doc and the contributor docs were said to overlap, with the contributor docs mixing what to do with why the monitor does it. This keeps in the contributor docs what contributors need, and links to the design doc for the reasons.

  • contributing-docs/18_contribution_workflow.rst, "CI in your fork": the setup steps are unchanged.
    • The long paragraph after them is split into three subsections: "What your pull request shows", "Changes to CI files" and "Joining and leaving the pilot".
    • Added from the design doc, because contributors need it:
      • what each check on the pull request means;
      • a new push removes ready for maintainer review until the new run is green;
      • comments and reviews hold off the 30-day closure;
      • what use project ci means for them;
      • how to recover from a closure for changing the gate, and that a closure for a project CI run that should not have happened needs a maintainer to reopen;
      • leaving the pilot does not move pull requests already labelled fork ci required;
      • a private apache org membership makes a committer count as external.
    • The reasons ("Tested base", "Trusting a green fork run", "Gate protection") are now links to the design doc.
    • The ci-in-your-fork anchor, used by the bot's comments and other docs, is unchanged.
  • contributing-docs/25_maintainer_pr_triage.md: drops a paragraph that repeated the needs project ci rule above it.
    • Moving a pull request to project CI is now three steps:
      • add use project ci;
      • right after, rebase the pull request or close and reopen it, because the label starts no project CI;
      • after a close and reopen, wait for CI passed to turn pending before merging.
    • The mechanics are a link to the design doc's "The CI passed check" section. That also drops the "15 minutes" that disagreed with the 5-minute monitor.
  • contributing-docs/05_pull_requests.rst:
    • The fork CI bullet is down to one sentence and a link; it repeated the pilot scope and the draft rule.
    • The approval paragraph links "Changes to CI files" instead of listing the CI-defining files a third time.
  • dev/breeze/doc/08_ci_tasks.rst: the fork-ci-reconcile and approve-workflow-runs sections now say what each command is for and link to the design docs.
    • The reconciler section had gone stale: it said PRs are closed after a week (it is 30 days) and kept in draft until green (a failed run no longer drafts).
  • dev/breeze/doc/ci/08_fork_ci_for_external_contributors.md:
    • A note at the top says it is the maintainer and design reference and points contributors and triagers to their docs.
    • The bullet on the use project ci window now says to rebase or close and reopen after adding the label by hand. A rebase closes the window, because the fork result stays on the old commit.

Two other open PRs change what these docs describe, and whichever merges second updates the text:

Tested: static checks pass on the changed files, including link checks, markdownlint and the RST checks.


Was generative AI tooling used to co-author this PR?
  • Yes — Claude Code (Claude Opus 5)

Generated-by: Claude Code (Claude Opus 5) following the guidelines

🤖 Generated with Claude Code

https://claude.ai/code/session_01NyQq9U7i5HhjDgrQ9qd3gq

The contributor docs and the fork CI design doc overlapped, and the
contributor section mixed what to do with why the monitor does it, as
was raised on the dev list. Contributors now find what their pull
request shows and what to do in one place, with links to the design
doc for the reasons, and the design doc points them there.

Generated-by: Claude Opus 5
Claude-Session: https://claude.ai/code/session_01NyQq9U7i5HhjDgrQ9qd3gq
A pull request closed because project CI ran for it although it should
not have stays closed when its author reopens it; only a maintainer can
reopen it, unlike one closed for changing the gate.

Generated-by: Claude Opus 5
Claude-Session: https://claude.ai/code/session_01NyQq9U7i5HhjDgrQ9qd3gq
The pull request guide, the breeze CI commands page and the triage guide
each restated part of how fork CI works, and the breeze page had gone
stale (a one-week closure, drafting until green). Each now keeps what
its reader acts on and links to the contributor section or the design.

Generated-by: Claude Opus 5
Claude-Session: https://claude.ai/code/session_01NyQq9U7i5HhjDgrQ9qd3gq
Adding the label by hand starts no project CI, and until the next
monitor run a green fork result still lets the pull request merge. A
rebase moves the head past that result, and a close and reopen starts
project CI.

Generated-by: Claude Opus 5
Claude-Session: https://claude.ai/code/session_01NyQq9U7i5HhjDgrQ9qd3gq
@potiuk
potiuk force-pushed the fork-ci-docs-consolidate branch from 23d2c2a to 1d4669f Compare November 15, 2026 23:18
@potiuk
potiuk enabled auto-merge (squash) November 15, 2026 23:22
@potiuk
potiuk merged commit c4aa191 into apache:main Nov 15, 2026
59 checks passed
@potiuk
potiuk deleted the fork-ci-docs-consolidate branch November 15, 2026 23:28
@github-actions

Copy link
Copy Markdown
Contributor

Backport failed to create: v3-4-test. View the failure log Run details

Note: As of Merging PRs targeted for Airflow 3.X
the committer who merges the PR is responsible for backporting the PRs that are bug fixes (generally speaking) to the maintenance branches.

In matter of doubt please ask in #release-management Slack channel.

Status Branch Result
❌ v3-4-test Commit Link

You can attempt to backport this manually by running:

cherry_picker c4aa191 v3-4-test

This should apply the commit to the v3-4-test branch and leave the commit in conflict state marking
the files that need manual conflict resolution.

After you have resolved the conflicts, you can continue the backport process by running:

cherry_picker --continue

If you don't have cherry-picker installed, see the installation guide.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants