Skip to content

Notify SDKs when the API specification is published #224

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
Stephen Belanger (Qard) wants to merge 8 commits into from
Closed

Notify SDKs when the API specification is published #224

Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
978fdf4
Notify SDK repositories when the API spec is published
Qard Oct 30, 2026
01c02ff
Send only the published spec commit to SDK receivers
Qard Oct 30, 2026
9251a91
Use Bash and jq for SDK notifications and spec validation
Qard Oct 30, 2026
e89900b
Simplify SDK notification targets and restore spec validation
Qard Oct 30, 2026
2416138
List SDK notification targets on separate lines
Qard Oct 30, 2026
cf03ac3
Remove internal SDK automation details from public README
Qard Oct 30, 2026
d5a7286
Send a simple SDK refresh notification
Qard Oct 30, 2026
4274207
Require dedicated credentials for SDK dispatch
Qard Oct 30, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 38 additions & 0 deletions .github/workflows/dispatch-sdk-updates.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
name: Notify SDKs of published spec updates

on:
push:
branches: [main]
workflow_dispatch:

permissions:
contents: read

jobs:
dispatch:
if: github.ref == 'refs/heads/main'
runs-on: ubuntu-latest
strategy:
fail-fast: false
matrix:
repository:
- braintrust-sdk-rust
steps:
- uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
- name: Create scoped notification token
id: bot
uses: actions/create-github-app-token@bcd2ba49218906704ab6c1aa796996da409d3eb1 # v3.2.0
with:
app-id: ${{ vars.SDK_DISPATCH_APP_ID }}
private-key: ${{ secrets.SDK_DISPATCH_APP_PRIVATE_KEY }}
owner: braintrustdata
repositories: ${{ matrix.repository }}
permission-contents: write
- name: Notify SDK receiver
env:
GH_TOKEN: ${{ steps.bot.outputs.token }}
SDK_REPOSITORY: ${{ matrix.repository }}
run: |
set -euo pipefail
gh api --method POST "repos/braintrustdata/$SDK_REPOSITORY/dispatches" \
-f event_type=braintrust-openapi-updated
Loading