docs: add SDK API reference for Rust, Python, and Kotlin (#11251)

This commit is contained in:
Alex Hancock
2026-08-24 20:07:29 +00:00
committed by GitHub
parent 4db9e21b98
commit f9ac24cbfc
33 changed files with 2606 additions and 23 deletions
+10
View File
@@ -246,6 +246,16 @@ jobs:
cd ui/sdk
pnpm run lint
gdk-api-docs-check:
name: Check GDK API Reference is Up-to-Date
runs-on: ubuntu-latest
steps:
- name: Checkout Code
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
- name: Check generated GDK API reference data
run: python3 documentation/automation/gdk-api/generate.py --check
desktop-lint:
name: Test and Lint Electron Desktop App
runs-on: macos-latest
+50
View File
@@ -0,0 +1,50 @@
# Regenerates the GDK API reference data from the goose-sdk UniFFI surface and
# opens a PR when it drifts from what is committed.
#
# The generator is deterministic and needs no build or API key, so this stays a
# plain script run rather than an AI-assisted job.
name: Update GDK API Reference
on:
workflow_dispatch:
release:
types: [published]
permissions:
contents: read
jobs:
update-gdk-api-docs:
name: Update GDK API reference
runs-on: ubuntu-latest
permissions:
contents: write
pull-requests: write
steps:
- name: Checkout repository
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
- name: Regenerate GDK API reference data
run: python3 documentation/automation/gdk-api/generate.py
- name: Create pull request
uses: peter-evans/create-pull-request@5f6978faf089d4d20b00c7766989d076bb2fc7f1 # v8.1.1
with:
branch: docs/auto-gdk-api-reference
delete-branch: true
add-paths: documentation/src/data/gdk-api.json
commit-message: "docs: update GDK API reference data"
title: "docs: update GDK API reference"
body: |
Regenerated `documentation/src/data/gdk-api.json` from
`crates/goose-sdk/src/bindings.rs`.
- **Triggered by**: ${{ github.event_name }}
- **Release**: ${{ github.event.release.tag_name || 'n/a' }}
The GDK API reference renders from this file, so merging publishes the
updated Rust, Python, and Kotlin reference docs.
labels: |
documentation
automated
+1 -1
View File
@@ -1,4 +1,4 @@
name: Maven SDK
name: Maven GDK
on:
workflow_dispatch:
+1 -1
View File
@@ -1,4 +1,4 @@
name: Python SDK Wheels
name: Python GDK Wheels
on:
workflow_dispatch: