Skip to content

ci: trigger docs SDK reference sync after SDK release#1492

Open
mishushakov wants to merge 1 commit into
mainfrom
mishushakov/trigger-docs-sync-job
Open

ci: trigger docs SDK reference sync after SDK release#1492
mishushakov wants to merge 1 commit into
mainfrom
mishushakov/trigger-docs-sync-job

Conversation

@mishushakov

Copy link
Copy Markdown
Member

Adds a trigger-docs-sync job to the release workflow that dispatches an sdk-release repository event to e2b-dev/docs, so the docs SDK reference regenerates automatically on release. It mints a scoped GitHub App token for the docs repo and dispatches with sdk=all / version=latest. The job runs only when publish succeeds and at least one of the JS or Python SDKs was released, so a CLI-only release (or skipped CLI) won't trigger it.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@changeset-bot

changeset-bot Bot commented Jun 26, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: f0743b1

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@cla-bot cla-bot Bot added the cla-signed label Jun 26, 2026
@chatgpt-codex-connector

Copy link
Copy Markdown

Codex usage limits have been reached for code reviews. Please check with the admins of this repo to increase the limits by adding credits.
Credits must be used to enable repository wide code reviews.

@cursor

cursor Bot commented Jun 26, 2026

Copy link
Copy Markdown

PR Summary

Low Risk
CI-only change using an existing app token pattern; no runtime or SDK code is modified.

Overview
Adds a trigger-docs-sync job to .github/workflows/release.yml that runs after a successful publish when the JS or Python SDK is part of the release. It uses the Autofixer GitHub App to get a token scoped to e2b-dev/docs and dispatches sdk-release with client_payload sdk=all and version=latest. CLI-only releases do not run this job.

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

@github-actions

Copy link
Copy Markdown
Contributor

Package Artifacts

Built from b2ccc7e. Download artifacts from this workflow run.

JS SDK (e2b@2.31.1-mishushakov-trigger-docs-sync-job.0):

npm install ./e2b-2.31.1-mishushakov-trigger-docs-sync-job.0.tgz

CLI (@e2b/cli@2.13.1-mishushakov-trigger-docs-sync-job.0):

npm install ./e2b-cli-2.13.1-mishushakov-trigger-docs-sync-job.0.tgz

Python SDK (e2b==2.30.0+mishushakov-trigger-docs-sync-job):

pip install ./e2b-2.30.0+mishushakov.trigger.docs.sync.job-py3-none-any.whl

@claude claude 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.

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant