Skip to content

docs: trim stale native-image CI note in AGENTS.md#1000

Merged
bestbeforetoday merged 2 commits into
substrait-io:mainfrom
nielspardon:docs-update-native-image-ci-note
Jul 16, 2026
Merged

docs: trim stale native-image CI note in AGENTS.md#1000
bestbeforetoday merged 2 commits into
substrait-io:mainfrom
nielspardon:docs-update-native-image-ci-note

Conversation

@nielspardon

@nielspardon nielspardon commented Jul 10, 2026

Copy link
Copy Markdown
Member

Summary

Trims the AGENTS.md note about monitoring the native-image CI job down to the one durable, non-obvious fact.

The note originally existed to warn contributors/agents that a PR staying yellow was usually just waiting on the slow macOS Build Isthmus Native Image long-pole job. #997 removed that long pole — the per-PR native build is now Linux only, uses --quick-build-native, and runs in parallel with the java/integration jobs. So most of what the note (and my first pass at updating it) described was either the absence of a gotcha or detail already spelled out in pr.yml.

Per @bestbeforetoday's review feedback — this is guidance loaded into an agent's context every session, so it should earn its keep — I cut it to the single fact that isn't easily discoverable and that changes behavior:

The macOS native image is not built on PRs (only Linux is), so macOS-specific native regressions surface on main or the weekly native-image-macos.yml run, not on the PR.

Docs-only; no code or workflow behavior is affected.

🤖 Generated with AI

The per-PR native-image job no longer builds the macOS image and no longer
depends on the java/integration jobs, so the "macOS native image is the PR
long pole" guidance is stale.

Reflect the current setup: PRs build the Linux native image only (with
--quick-build-native, in parallel with the other jobs), while the macOS
native image is built out-of-band in native-image-macos.yml on push to
main, a weekly schedule, and workflow_dispatch.
@bestbeforetoday

Copy link
Copy Markdown
Member

The information all looks correct to me. I wonder how useful it is to aid an AI agent in developing code. Is it worth taking up more of the context window with this information or would it be more effective to just remove it?

Per review feedback: the expanded guidance mostly documented the absence
of a gotcha (substrait-io#997 removed the macOS long-pole from PRs) and duplicated
what pr.yml already states. Keep only the non-obvious residual: macOS
native regressions surface on main/weekly, not on the PR.
@nielspardon nielspardon changed the title docs: update native-image CI guidance for Linux-only per-PR build docs: trim stale native-image CI note in AGENTS.md Jul 16, 2026
@nielspardon

Copy link
Copy Markdown
Member Author

Good push — agreed. As the thing this file is written for, I'll say the note was low value: it's guidance loaded into context every session, so it should earn its keep, and this one didn't. Two reasons beyond the general context-window cost:

  • It was operational CI trivia, not something that changes how code gets written, and most of it (the pr.yml job layout, --quick-build-native, needs:) is discoverable by just reading the workflow.
  • The note originally existed to warn "don't panic when a PR stays yellow — the macOS native job is a slow long pole." ci: build only the Linux native image per PR #997 removed that long pole, so the expanded version was largely documenting the absence of a gotcha.

So rather than remove it outright, I trimmed it to the one residual fact that isn't obvious and that actually changes behavior: macOS native isn't built per-PR, so those regressions land on main/the weekly run, not the PR. Everything else is gone. Updated the PR title/body to match.

@bestbeforetoday
bestbeforetoday merged commit 48133f9 into substrait-io:main Jul 16, 2026
15 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants