60e0ffc959
Upgrade checks / Notify on failure (push) Has been cancelled
Upgrade checks / Close issue on success (push) Has been cancelled
Schema Crash Test / Real-world schema crash test (232K schemas) (push) Has been cancelled
Run static analysis / static_analysis (push) Has been cancelled
Tests / Tests: Python 3.10 on ubuntu-latest (push) Has been cancelled
Tests / Tests: Python 3.13 on ubuntu-latest (push) Has been cancelled
Tests / Tests: Python 3.10 on windows-latest (push) Has been cancelled
Tests / Tests with lowest-direct dependencies (push) Has been cancelled
Tests / MCP conformance tests (push) Has been cancelled
Tests / Integration tests (push) Has been cancelled
Tests / Package install smoke (push) Has been cancelled
Upgrade checks / Static analysis (push) Has been cancelled
Upgrade checks / Tests: Python 3.10 on ubuntu-latest (push) Has been cancelled
Upgrade checks / Tests: Python 3.13 on ubuntu-latest (push) Has been cancelled
Upgrade checks / Tests: Python 3.10 on windows-latest (push) Has been cancelled
Upgrade checks / Integration tests (push) Has been cancelled
Update MCPServerConfig Schema / update-config-schema (push) Has been cancelled
Update SDK Documentation / update-sdk-docs (push) Has been cancelled
70 lines
2.2 KiB
YAML
70 lines
2.2 KiB
YAML
name: Update SDK Documentation
|
|
|
|
# Regenerates SDK docs on pushes to main and opens a long-lived PR
|
|
# with the changes, so contributor PRs stay clean.
|
|
|
|
on:
|
|
push:
|
|
branches: ["main"]
|
|
paths:
|
|
- "fastmcp_slim/**"
|
|
- "pyproject.toml"
|
|
workflow_dispatch:
|
|
|
|
permissions:
|
|
contents: write
|
|
pull-requests: write
|
|
|
|
jobs:
|
|
update-sdk-docs:
|
|
timeout-minutes: 5
|
|
runs-on: ubuntu-latest
|
|
|
|
steps:
|
|
- name: Generate Marvin App token
|
|
id: marvin-token
|
|
uses: actions/create-github-app-token@v3
|
|
with:
|
|
app-id: ${{ secrets.MARVIN_APP_ID }}
|
|
private-key: ${{ secrets.MARVIN_APP_PRIVATE_KEY }}
|
|
|
|
- uses: actions/checkout@v7
|
|
with:
|
|
token: ${{ steps.marvin-token.outputs.token }}
|
|
|
|
- name: Install uv
|
|
uses: astral-sh/setup-uv@v7
|
|
with:
|
|
enable-cache: true
|
|
cache-dependency-glob: "uv.lock"
|
|
|
|
- name: Install dependencies
|
|
run: uv sync --python 3.12
|
|
|
|
- name: Install just
|
|
uses: extractions/setup-just@v4
|
|
|
|
- name: Generate SDK documentation
|
|
run: just api-ref-all
|
|
|
|
- name: Create Pull Request
|
|
uses: peter-evans/create-pull-request@v8
|
|
with:
|
|
token: ${{ steps.marvin-token.outputs.token }}
|
|
commit-message: "chore: Update SDK documentation"
|
|
title: "chore: Update SDK documentation"
|
|
body: |
|
|
This PR updates the auto-generated SDK documentation to reflect the latest source code changes.
|
|
|
|
📚 Documentation is automatically generated from the source code docstrings and type annotations.
|
|
|
|
**Note:** This PR is fully automated and will update itself with any subsequent changes to the SDK, or close automatically if the documentation becomes up-to-date through other means. Feel free to leave it open until you're ready to merge.
|
|
|
|
🤖 Generated by Marvin
|
|
branch: marvin/update-sdk-docs
|
|
labels: |
|
|
ignore in release notes
|
|
delete-branch: true
|
|
author: "marvin-context-protocol[bot] <225465937+marvin-context-protocol[bot]@users.noreply.github.com>"
|
|
committer: "marvin-context-protocol[bot] <225465937+marvin-context-protocol[bot]@users.noreply.github.com>"
|