Skip to content

chore: minor docs workflow improvements + fix #84

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

Merged
marikaner merged 2 commits into from
Aug 18, 2026
Merged

chore: minor docs workflow improvements + fix #84

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
391f7ed
improve workflow
marikaner Aug 18, 2026
97afe6d
Apply suggestion from @marikaner
marikaner Aug 18, 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
33 changes: 20 additions & 13 deletions .github/workflows/api-doc.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ jobs:
with:
token: ${{ steps.app-token.outputs.token }}
ref: ${{ github.ref }}

- name: Generate docs
run: uv run make docs

Expand All @@ -41,7 +42,7 @@ jobs:
repository: SAP/ai-sdk
token: ${{ steps.app-token.outputs.token }}
path: ai-sdk
persist-credentials: false
persist-credentials: true

- name: Configure git
env:
Expand All @@ -51,33 +52,39 @@ jobs:
git -C ai-sdk config user.email "$BOT_EMAIL"
git -C ai-sdk config user.name "$BOT_NAME"

- name: Update api docs
id: update-docs
- name: Prepare docs branch
id: prepare-docs
env:
REF: ${{ github.ref_name }}
run: |
BRANCH="api-docs-python-$REF"
echo "branch=$BRANCH" >> "$GITHUB_OUTPUT"
cd ai-sdk
git checkout -b "$BRANCH"
rm -rf static/api-python
cp -r ../api-docs/ static/api-python
git add static/api-python
if git diff --cached --quiet; then
git -C ai-sdk checkout -b "$BRANCH"
rm -rf ai-sdk/static/api-python
cp -r api-docs/ ai-sdk/static/api-python
git -C ai-sdk add static/api-python
if git -C ai-sdk diff --cached --quiet; then
echo "No documentation changes to commit"
echo "changed=false" >> "$GITHUB_OUTPUT"
else
git commit -m "chore: update Python API docs ($REF)"
git push --force origin "$BRANCH"
echo "changed=true" >> "$GITHUB_OUTPUT"
fi

- name: Push docs branch
if: steps.prepare-docs.outputs.changed == 'true'
env:
REF: ${{ github.ref_name }}
BRANCH: ${{ steps.prepare-docs.outputs.branch }}
run: |
git -C ai-sdk commit -m "chore: update Python API docs ($REF)"
git -C ai-sdk push --force origin "$BRANCH"

- name: Create pull request
if: steps.update-docs.outputs.changed == 'true'
if: steps.prepare-docs.outputs.changed == 'true'
env:
GH_TOKEN: ${{ steps.app-token.outputs.token }}
REF: ${{ github.ref_name }}
BRANCH: ${{ steps.update-docs.outputs.branch }}
BRANCH: ${{ steps.prepare-docs.outputs.branch }}
run: |
if [ "$GITHUB_EVENT_NAME" = "workflow_dispatch" ]; then
REF_URL="$GITHUB_SERVER_URL/$GITHUB_REPOSITORY/tree/$REF"
Expand Down
Loading