ci: trigger docs SDK reference sync after SDK release#1492
Conversation
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
|
|
Codex usage limits have been reached for code reviews. Please check with the admins of this repo to increase the limits by adding credits. |
PR SummaryLow Risk Overview Reviewed by Cursor Bugbot for commit f0743b1. Bugbot is set up for automated code reviews on this repo. Configure here. |
Package ArtifactsBuilt from b2ccc7e. Download artifacts from this workflow run. JS SDK ( npm install ./e2b-2.31.1-mishushakov-trigger-docs-sync-job.0.tgzCLI ( npm install ./e2b-cli-2.13.1-mishushakov-trigger-docs-sync-job.0.tgzPython SDK ( pip install ./e2b-2.30.0+mishushakov.trigger.docs.sync.job-py3-none-any.whl |
There was a problem hiding this comment.
LGTM — straightforward CI addition using the existing app-token pattern.
Extended reasoning...
Overview
This PR adds a single trigger-docs-sync job to .github/workflows/release.yml. The job dispatches an sdk-release repository event to e2b-dev/docs so the docs SDK reference regenerates after a successful SDK release. It is gated on publish succeeding and at least one of the JS or Python SDKs being part of the release.
Security risks
Minimal. The change mints a scoped GitHub App token (AUTOFIXER_APP_ID / AUTOFIXER_APP_SECRET) limited to owner: e2b-dev, repositories: docs, following an existing pattern in this repo. The gh api call uses static -f/-F flags with no untrusted input, so there is no command-injection surface. The dispatched payload (sdk=all, version=latest) is hardcoded.
Level of scrutiny
Low. This is a CI-only change that adds a new job — it cannot affect runtime SDK behavior, does not touch any production code, and only runs after a successful release. The conditional logic correctly excludes CLI-only releases.
Other factors
Bug hunting found no issues. The change is small (24 added lines), self-contained, and follows established workflow patterns. Cursor Bugbot also flagged this as low risk.
Adds a
trigger-docs-syncjob to the release workflow that dispatches ansdk-releaserepository event toe2b-dev/docs, so the docs SDK reference regenerates automatically on release. It mints a scoped GitHub App token for the docs repo and dispatches withsdk=all/version=latest. The job runs only whenpublishsucceeds and at least one of the JS or Python SDKs was released, so a CLI-only release (or skipped CLI) won't trigger it.