Skip to content

chore(claude-agents)!: regenerate the API report for the host options from #135 - #161

Closed
XieX wants to merge 1 commit into
mainfrom
xie/regenerate-claude-agents-api-report
Closed

XieX wants to merge 1 commit into
mainfrom
xie/regenerate-claude-agents-api-report

Conversation

@XieX

@XieX XieX commented Oct 23, 2026 •

Copy link
Copy Markdown
Contributor

yarn api:check has failed on main since #135 ("Check API reports": packages/claude-agents/: an API report is out of date), and every PR based on main inherits that failure. #135 added the optional cwd and settingSources host options to the public @launchdarkly/ai-claude-agents functions, but nobody regenerated etc/ai-claude-agents.api.md after #153 committed it.

This PR only commits the output of yarn --cwd packages/claude-agents api:update. No source changes. The report now shows:

Why the !: the API compatibility check counts every changed declaration as breaking. The breaking change already shipped in #135, and that PR declared it (feat(claude-agents)!:). This PR changes no behaviour; the ! only satisfies the check for the report diff. A reviewer could apply api-compatible instead and drop the !.

Testing (locally, after yarn install && yarn build):

  • yarn api:check exits 0
  • yarn api:surface exits 0

🤖 Generated with Claude Code


Note

Overview
Regenerates @launchdarkly/ai-claude-agents API Extractor report (etc/ai-claude-agents.api.md) so yarn api:check passes after #135 landed host options in source without updating the report. No runtime or source changes—only the committed api:update output.

The refreshed report documents ClaudeAgentsHostOptions on claudeAgents, claudeGraph, createClaudeAgentsHandler, and toClaudeAgents, adds the SettingSource import, and reflects signature renames (claudeGraph’s second arg options → input, createClaudeAgentsHandler’s param input → options). API Extractor also emits an ae-forgotten-export warning because ClaudeAgentsHostOptions is not exported from the package entry point.

Reviewed by Cursor Bugbot for commit de6a7ec. Bugbot is set up for automated code reviews on this repo. Configure here.

… from #135

#135 added the optional `cwd` and `settingSources` host options to
`claudeAgents`, `claudeGraph`, `createClaudeAgentsHandler` and
`toClaudeAgents` without regenerating `etc/ai-claude-agents.api.md`,
so `yarn api:check` has failed on main since. This is the output of
`yarn --cwd packages/claude-agents api:update`, nothing else.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@XieX
XieX requested a review from a team as a code owner October 23, 2026 17:59
@XieX
XieX requested a review from jeffdupont October 23, 2026 19:26
@jeffdupont

Copy link
Copy Markdown
Contributor

Closing as a duplicate of #160, which merged the same regenerated claude-agents API report. #135's breaking change is already in the changelog, so this one's ! would have listed it a second time.

@jeffdupont jeffdupont closed this Oct 23, 2026
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