Skip to content

ci: check custom-code budgets against main's policy - #925

Merged
apcha-oai merged 1 commit into
mainfrom
apcha/custom-code-ratchet
Aug 21, 2026
Merged

ci: check custom-code budgets against main's policy#925
apcha-oai merged 1 commit into
mainfrom
apcha/custom-code-ratchet

Conversation

@apcha-oai

@apcha-oai apcha-oai commented Aug 21, 2026

Copy link
Copy Markdown
Contributor

Summary

Catch accidental growth in the SDK's remaining generated-file customization before it becomes a large patch to maintain. This ports the same layout and tooling approved in Python #3714 and Python #3715, including Python's trusted report computation.

The existing workflow pair measures additions plus deletions against verified generated output, using the checker and budget from main. A PR cannot increase its own allowance; budget changes must be isolated and explicitly justified, and increases require a human approving review. Agents cannot approve or bypass increases.

Technical details live in scripts/castiron/CUSTOM_CODE.md, with references from AGENTS and CONTRIBUTING. No extra workflow files, SDK API changes, checkpoint edits, exclusion changes, or CODEOWNERS changes. Ruleset enforcement is intentionally deferred.

Do not merge until the compatible WebSocket event regeneration reaches public main. The 2,000-line budget is sized for the fixed generated baseline, not today’s large event customization. A local merge preview of the fixed generation plus this tooling measures +1,524 / −208 = 1,732 lines, leaving 268 lines below the ceiling. The budget-only foundation can merge independently. Verify this tooling against the released fix before merging.

Stack

The budget-only foundation has merged. This tooling commit is now restacked onto main at a5228db57265; the tooling patch is unchanged and the PR contains no budget-file change. CI is rerunning against main. The trusted statuses become active after the tooling lands, but will not be required until a separately authorized ruleset rollout.

@apcha-oai apcha-oai added the custom-code-burndown Behavior-preserving cleanup of custom code in generated SDK files label Aug 21, 2026
@github-actions

github-actions Bot commented Aug 21, 2026

Copy link
Copy Markdown
Contributor

Castiron custom code

✅ No new custom-code files detected.

57 mixed files remain; 2 existing customizations changed.

Compared a5228db572659e578abab272. Generated baselines verified.

File Result Current custom patch
scripts/castiron/custom_code_report.py Existing customization changed +125 / −31
scripts/castiron/test_custom_code_report.py Existing customization changed +287 / −28
55 existing customizations unchanged
  • openai-java-core/src/main/kotlin/com/openai/models/audio/AudioResponseFormat.kt
  • openai-java-core/src/main/kotlin/com/openai/models/beta/responses/BetaResponsesServerEvent.kt
  • openai-java-core/src/main/kotlin/com/openai/models/chat/completions/ChatCompletionCreateParams.kt
  • openai-java-core/src/main/kotlin/com/openai/models/chat/completions/ChatCompletionMessageFunctionToolCall.kt
  • openai-java-core/src/main/kotlin/com/openai/models/chat/completions/ChatCompletionToolMessageParam.kt
  • openai-java-core/src/main/kotlin/com/openai/models/embeddings/Embedding.kt
  • openai-java-core/src/main/kotlin/com/openai/models/embeddings/EmbeddingCreateParams.kt
  • openai-java-core/src/main/kotlin/com/openai/models/responses/ResponseCreateParams.kt
  • openai-java-core/src/main/kotlin/com/openai/models/responses/ResponseFunctionToolCall.kt
  • openai-java-core/src/main/kotlin/com/openai/models/responses/ResponseFunctionWebSearch.kt
  • openai-java-core/src/main/kotlin/com/openai/models/responses/ResponseInputItem.kt
  • openai-java-core/src/main/kotlin/com/openai/models/responses/ResponseTextConfig.kt
  • openai-java-core/src/main/kotlin/com/openai/models/responses/ResponsesServerEvent.kt
  • openai-java-core/src/main/kotlin/com/openai/models/videos/Video.kt
  • openai-java-core/src/main/kotlin/com/openai/services/async/BetaServiceAsync.kt
  • openai-java-core/src/main/kotlin/com/openai/services/async/BetaServiceAsyncImpl.kt
  • openai-java-core/src/main/kotlin/com/openai/services/async/ResponseServiceAsync.kt
  • openai-java-core/src/main/kotlin/com/openai/services/async/ResponseServiceAsyncImpl.kt
  • openai-java-core/src/main/kotlin/com/openai/services/async/WebhookServiceAsync.kt
  • openai-java-core/src/main/kotlin/com/openai/services/async/WebhookServiceAsyncImpl.kt
  • openai-java-core/src/main/kotlin/com/openai/services/async/audio/TranscriptionServiceAsyncImpl.kt
  • openai-java-core/src/main/kotlin/com/openai/services/async/beta/ResponseServiceAsyncImpl.kt
  • openai-java-core/src/main/kotlin/com/openai/services/async/chat/ChatCompletionServiceAsync.kt
  • openai-java-core/src/main/kotlin/com/openai/services/async/finetuning/checkpoints/PermissionServiceAsyncImpl.kt
  • openai-java-core/src/main/kotlin/com/openai/services/blocking/BetaService.kt
  • openai-java-core/src/main/kotlin/com/openai/services/blocking/BetaServiceImpl.kt
  • openai-java-core/src/main/kotlin/com/openai/services/blocking/ResponseService.kt
  • openai-java-core/src/main/kotlin/com/openai/services/blocking/ResponseServiceImpl.kt
  • openai-java-core/src/main/kotlin/com/openai/services/blocking/WebhookService.kt
  • openai-java-core/src/main/kotlin/com/openai/services/blocking/WebhookServiceImpl.kt
  • openai-java-core/src/main/kotlin/com/openai/services/blocking/audio/TranscriptionServiceImpl.kt
  • openai-java-core/src/main/kotlin/com/openai/services/blocking/beta/ResponseServiceImpl.kt
  • openai-java-core/src/main/kotlin/com/openai/services/blocking/chat/ChatCompletionService.kt
  • openai-java-core/src/main/kotlin/com/openai/services/blocking/finetuning/checkpoints/PermissionServiceImpl.kt
  • openai-java-core/src/test/kotlin/com/openai/models/beta/responses/BetaResponsesServerEventTest.kt
  • openai-java-core/src/test/kotlin/com/openai/models/responses/ResponsesServerEventTest.kt
  • openai-java-core/src/test/kotlin/com/openai/services/async/CompletionServiceAsyncTest.kt
  • openai-java-core/src/test/kotlin/com/openai/services/async/ImageServiceAsyncTest.kt
  • openai-java-core/src/test/kotlin/com/openai/services/async/ResponseServiceAsyncTest.kt
  • openai-java-core/src/test/kotlin/com/openai/services/async/WebhookServiceAsyncTest.kt

15 more in the full report.

A changed generated baseline means this report cannot reliably identify which handwritten lines changed.

Inspect the custom-code diff

Download the exact patch produced by this run (requires repository access):

gh run download 32506621504 --repo openai/openai-java \
  --name castiron-custom-code-32506621504-1 --dir /tmp/castiron-custom-code-32506621504-1
git apply --stat /tmp/castiron-custom-code-32506621504-1/custom-code.patch
cat /tmp/castiron-custom-code-32506621504-1/custom-code.patch

Or reproduce it from an SDK checkout containing the vendored reporter:

git fetch --no-tags origin a5228db57265b92e8c7597fcd4c78cd968483c50 9e578abab2724cc32cfc8b38c6e6619766f25c03
python3 scripts/castiron/custom_code_report.py report \
  --base a5228db57265b92e8c7597fcd4c78cd968483c50 \
  --head 9e578abab2724cc32cfc8b38c6e6619766f25c03 --fetch --require-head-hash --public \
  --out /tmp/castiron-custom-code-9e578abab272
cat /tmp/castiron-custom-code-9e578abab272/custom-code.patch

This is the current full custom patch for mixed files, not an attribution of only the handwritten lines changed by this PR.

Full report and patch

@apcha-oai
apcha-oai marked this pull request as ready for review August 21, 2026 17:01
@apcha-oai
apcha-oai requested a review from a team as a code owner August 21, 2026 17:01
@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Aug 21, 2026

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review Completed 2026-08-21T17:11:25.858835Z 9e578ab New commits
🔒 Security Review Completed 2026-08-21T17:12:03.322436Z 9e578ab New commits
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@jbeckwith-oai jbeckwith-oai 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.

Approved at the reviewer's request.

@apcha-oai
apcha-oai force-pushed the apcha/custom-code-ratchet branch from 6ce1590 to 9e578ab Compare August 21, 2026 17:08
@apcha-oai
apcha-oai changed the base branch from apcha/custom-code-budget to main August 21, 2026 17:08
@openai-sdks

openai-sdks Bot commented Aug 21, 2026

Copy link
Copy Markdown
Contributor

OkTest Summary

237/237 SDK tests passed in 16.868s for Java SDK PR #925.

Test results — 42 files
Test Result Time
tests/chat-completions-complex-body.test.ts ✅ Passed 244ms
tests/chat-completions-create.test.ts ✅ Passed 653ms
tests/chat-completions-stream.test.ts ✅ Passed 378ms
tests/files-content-binary.test.ts ✅ Passed 331ms
tests/files-create-multipart.test.ts ✅ Passed 432ms
tests/files-list-pagination.test.ts ✅ Passed 383ms
tests/initialize-config.test.ts ✅ Passed 251ms
tests/instance-isolation.test.ts ✅ Passed 206ms
tests/models-list.test.ts ✅ Passed 343ms
tests/responses-background-lifecycle.test.ts ✅ Passed 356ms
tests/responses-body-method-errors.test.ts ✅ Passed 480ms
tests/responses-cancel-timeout.test.ts ✅ Passed 218ms
tests/responses-cancel.test.ts ✅ Passed 308ms
tests/responses-compact-retries.test.ts ✅ Passed 394ms
tests/responses-compact.test.ts ✅ Passed 331ms
tests/responses-create-advanced-stream.test.ts ✅ Passed 245ms
tests/responses-create-advanced.test.ts ✅ Passed 1.254s
tests/responses-create-disconnect.test.ts ✅ Passed 1.038s
tests/responses-create-errors.test.ts ✅ Passed 324ms
tests/responses-create-malformed-api-responses.test.ts ✅ Passed 314ms
tests/responses-create-retries.test.ts ✅ Passed 281ms
tests/responses-create-stream-failures.test.ts ✅ Passed 263ms
tests/responses-create-stream-timeout.test.ts ✅ Passed 209ms
tests/responses-create-stream-wire.test.ts ✅ Passed 6.341s
tests/responses-create-stream.test.ts ✅ Passed 140ms
tests/responses-create-terminal-states.test.ts ✅ Passed 458ms
tests/responses-create-timeout.test.ts ✅ Passed 281ms
tests/responses-create.test.ts ✅ Passed 822ms
tests/responses-delete.test.ts ✅ Passed 251ms
tests/responses-input-items-errors.test.ts ✅ Passed 301ms
tests/responses-input-items-list.test.ts ✅ Passed 353ms
tests/responses-input-items-options.test.ts ✅ Passed 189ms
tests/responses-input-tokens-count-timeout.test.ts ✅ Passed 242ms
tests/responses-input-tokens-count.test.ts ✅ Passed 345ms
tests/responses-malformed-inputs.test.ts ✅ Passed 5.368s
tests/responses-not-found-errors.test.ts ✅ Passed 528ms
tests/responses-parse.test.ts ✅ Passed 601ms
tests/responses-retrieve-retries.test.ts ✅ Passed 235ms
tests/responses-retrieve.test.ts ✅ Passed 403ms
tests/responses-stored-method-errors.test.ts ✅ Passed 1.108s
tests/retry-behavior.test.ts ✅ Passed 3.651s
tests/sdk-error-shape.test.ts ✅ Passed 407ms

View OkTest run #32506612345

SDK merge (a845c0254a4c) · head (9e578abab272) · base (a5228db57265) · OkTest (2b1bdfd25e98)

@chatgpt-codex-connector chatgpt-codex-connector Bot 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.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 9e578abab2

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".


def check_isolation(repo: Path, base: str, head: str) -> int | None:
# Validate even if the policy was removed by an earlier commit in this PR.
proposed = read_budget(repo, head)

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge Skip reading the policy when the PR does not change it

When a merge-queue constituent was branched before .castiron-ratchet.json was introduced, its raw PR head does not contain the file even though the synthetic merge candidate inherits the current policy from main. Calling read_budget(repo, head) before checking changed_paths therefore fails the isolation status for an otherwise mergeable PR that never touched the policy; determine whether the policy path changed first, and only read the proposed value when it did. This also conflicts with the repository invariant that the effective budget comes from main.

AGENTS.md reference: AGENTS.md:L16-L18

Useful? React with 👍 / 👎.

@apcha-oai
apcha-oai enabled auto-merge August 21, 2026 19:23
@apcha-oai
apcha-oai disabled auto-merge August 21, 2026 19:44
@apcha-oai
apcha-oai merged commit 85f8c34 into main Aug 21, 2026
12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

custom-code-burndown Behavior-preserving cleanup of custom code in generated SDK files

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants