Skip to content

[chore](build) Document incremental FE compilation for agents - #70685

Open
englefly wants to merge 1 commit into
apache:masterfrom
englefly:imporve/agent-fe-incremental-compile
Open

englefly wants to merge 1 commit into
apache:masterfrom
englefly:imporve/agent-fe-incremental-compile

Conversation

@englefly

Copy link
Copy Markdown
Contributor

Background

Agents follow AGENTS.md when building Doris. The repository provides tools/fast-compile-fe.sh to compile individual FE core Java files against an existing complete build.

What problem does this PR solve?

Issue Number: None
Related PR: None
PR Type: Build/CI/Chore

Problem Summary:

The build instructions require build.sh for every build, preventing agents from using the existing incremental FE compiler for small changes. Document incremental compilation first, with Maven as the fallback on failure, as an explicit exception to the full-build rule.

Details

  • Affected: Agent instructions for FE compilation in AGENTS.md.
  • Developer and release impact: Agents can compile a few FE core source or test files incrementally when a complete FE build exists. Required Checkstyle validation and tests still apply. No runtime or release changes.
  • License and third-party: None.
  • Rollback: Revert this documentation change.

Testing

Checked the documented source-file and --test arguments against tools/fast-compile-fe.sh. Ran git diff --check on the change. No build or tests run because only documentation changed.

Release note

None

Check List (For Author)

  • Behavior changed: No
  • Does this need documentation: No
  • Pre-submission status: Ready

AI Disclosure

  • Tool: Codex
  • Generated: Documentation change and PR description.
  • Human review: Pending author review.

### Background

Agents follow AGENTS.md when building Doris. The repository provides tools/fast-compile-fe.sh to compile individual FE core Java files against an existing complete build.

### What problem does this PR solve?

Issue Number: None
Related PR: None
PR Type: Build/CI/Chore

Problem Summary:

The build instructions require build.sh for every build, preventing agents from using the existing incremental FE compiler for small changes. Document incremental compilation first, with Maven as the fallback on failure, as an explicit exception to the full-build rule.

### Details

- **Affected:** Agent instructions for FE compilation in AGENTS.md.
- **Developer and release impact:** Agents can compile a few FE core source or test files incrementally when a complete FE build exists. Required Checkstyle validation and tests still apply. No runtime or release changes.
- **License and third-party:** None.
- **Rollback:** Revert this documentation change.

### Testing

Checked the documented source-file and --test arguments against tools/fast-compile-fe.sh. Ran git diff --check on the change. No build or tests run because only documentation changed.

### Release note

None

### Check List (For Author)

- Behavior changed: No
- Does this need documentation: No
- Pre-submission status: Ready

### AI Disclosure

- Tool: Codex
- Generated: Documentation change and PR description.
- Human review: Pending author review.
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.

1 participant