chore: Separate api-docs PR and trigger another workflow for it by emincihangeri · Pull Request #1718 · SAP/ai-sdk-js

emincihangeri · 2026-04-07T11:52:48Z

Context

Closes SAP/ai-sdk-js-backlog#453.

What this PR does and why it is needed

hyperspace-insights · 2026-04-07T11:53:05Z

Summary

The following content is AI-generated and provides a summary of the pull request:

Separate API Docs PR from Release Notes Workflow

Refactor

♻️ Decoupled the API documentation generation from the release notes workflow. Previously, API docs and release notes were bundled into a single PR during the release bump. They are now handled as two separate, independent PRs — improving modularity and allowing each to be triggered and merged independently.

Changes

.github/workflows/api-docs.yml: Refactored into a reusable workflow supporting both workflow_call (triggered from bump.yml) and workflow_dispatch (manual trigger). Replaced SSH-based git cloning with actions/checkout, switched to GH_CLOUD_SDK_JS_ADMIN_WRITE_TOKEN for authentication, and streamlined the steps for copying docs, creating a branch, and opening a dedicated API docs PR in the SAP/ai-sdk repository.
.github/workflows/bump.yml: Split the former prepare-release-notes-and-docs job into two separate jobs:
- prepare-release-notes: Now only handles release notes (removes API doc generation and copying steps).
- generate-api-docs: New job that calls the reusable api-docs.yml workflow after the bump, passing the version as input.
.github/workflows/publish-release.yml: Renamed check-docs-pr → check-release-notes-pr and merge-docs-pr → merge-release-notes-pr, along with all associated output variable and step name references, to reflect that this workflow now exclusively manages the release notes PR lifecycle.

🔄 Regenerate and Update Summary
✏️ Insert as PR Description (deletes this comment)
🗑️ Delete comment

PR Bot Information

Version: 1.20.0 | 📖 Documentation | 🚨 Create Incident | 💬 Feedback

Event Trigger: pull_request.opened
Summary Prompt: Default Prompt
Output Template: Default Template
LLM: anthropic--claude-4.6-sonnet
Correlation ID: 4d47c710-3278-11f1-8e1e-d560ad8a2037
File Content Strategy: Full file content
GithubContextProvider: chore(deps): Bump @langchain/core from 0.3.29 to 0.3.30 #453

💌 Have ideas or want to contribute? Create an issue and share your thoughts with us!
📑 Check out the documentation for more information.
📬 Subscribe to the Hyperspace PR Bot DL to get the latest announcements and pilot features!

Made with ❤️ by Hyperspace.

Co-authored-by: Marika Marszalkowski <marika.marszalkowski@sap.com>

marikaner

We should remove the non-existent token + env variable, everything else is details, but would be nice to have before merging.

Co-authored-by: Marika Marszalkowski <marika.marszalkowski@sap.com>

This reverts commit 4a92f92.

marikaner

one more thought: I think it would be even better, if you made a reusable create-api-docs-pr action. Then you could use that directly in the api-docs.yml and bump.yml

Co-authored-by: Marika Marszalkowski <marika.marszalkowski@sap.com>

emincihangeri · 2026-04-23T12:06:28Z

one more thought: I think it would be even better, if you made a reusable create-api-docs-pr action. Then you could use that directly in the api-docs.yml and bump.yml

So the bump workflow calling the api-docs.yml will no longer be the logic? but we still want to have the api-docs.yml for manual triggering then, right?

marikaner

I still have some requests. I think it was not necessary to move the api-docs implementation to an action (my bad) but it is a good idea, if we want to align this between Cloud SDK and AI SDK, so let's keep it as is.

Co-authored-by: Marika Marszalkowski <marika.marszalkowski@sap.com>

davidkna-sap

I've made some suggestions (also to pre-emptively reduce conflicts with #1822), please have a look - otherwise lgtm.

Co-authored-by: David Knaack <david.knaack@sap.com>

marikaner

LGTM. Thanks for putting that much effort into this 😊

* origin/main: chore(deps-dev): Bump typescript from 5.9.3 to 6.0.3 (#1828) chore: Configure `save-exact` for smoke test package (#1774) chore(type-tests): Replace context-incorrect jest `expect` with `tsd` `expectAssignable` (#1801) chore: Separate api-docs PR and trigger another workflow for it (#1718) chore: Use new pnpm-based license checker (#1728) chore(deps): Bump SonarSource/sonarqube-scan-action from 6.0.0 to 8.0.0 (#1827) chore(deps): Bump slackapi/slack-github-action from 3.0.2 to 3.0.3 (#1826) chore(sample): Refactor geocoding and forecast URL construction (#1824) fix: Check for isTemplateRef and append messages to messages_history (#1798) chore(deps): Bump zod from 4.4.1 to 4.4.2 (#1829) chore(deps): Bump github/codeql-action from 4.35.2 to 4.35.3 (#1825)

* origin/main: (25 commits) chore: Disable dependabot for v1 (#1832) chore: Fix lockfile (#1833) chore: Update available model list (#1830) chore(ci): Improve sonar coverage configuration (#1806) chore: Integrate Prettier for formatting in sync-model-types script (#1802) chore(deps-dev): Bump typescript from 5.9.3 to 6.0.3 (#1828) chore: Configure `save-exact` for smoke test package (#1774) chore(type-tests): Replace context-incorrect jest `expect` with `tsd` `expectAssignable` (#1801) chore: Separate api-docs PR and trigger another workflow for it (#1718) chore: Use new pnpm-based license checker (#1728) chore(deps): Bump SonarSource/sonarqube-scan-action from 6.0.0 to 8.0.0 (#1827) chore(deps): Bump slackapi/slack-github-action from 3.0.2 to 3.0.3 (#1826) chore(sample): Refactor geocoding and forecast URL construction (#1824) fix: Check for isTemplateRef and append messages to messages_history (#1798) chore(deps): Bump zod from 4.4.1 to 4.4.2 (#1829) chore(deps): Bump github/codeql-action from 4.35.2 to 4.35.3 (#1825) chore: update pnpm transitive dependencies (#1809) chore: Fix smoke test (#1816) chore(deps): Bump zod from 4.4.0 to 4.4.1 (#1820) chore(deps): Bump hono from 4.12.15 to 4.12.16 (#1819) ...

chore: Seperate api-docs PR and trigger another workflow for it

ad7dbf9

Merge branch 'main' into chore-separate-docs-prs

ccd3cf4

emincihangeri changed the title ~~chore: Seperate api-docs PR and trigger another workflow for it~~ chore: Separate api-docs PR and trigger another workflow for it Apr 7, 2026

emincihangeri requested a review from marikaner April 7, 2026 12:17

marikaner requested changes Apr 8, 2026

View reviewed changes

Comment thread .github/workflows/api-docs.yml Outdated

Comment thread .github/workflows/api-docs.yml Outdated

Comment thread .github/workflows/api-docs.yml Outdated

Comment thread .github/workflows/bump.yml Outdated

Update .github/workflows/bump.yml

7aa2991

Co-authored-by: Marika Marszalkowski <marika.marszalkowski@sap.com>

marikaner reviewed Apr 8, 2026

View reviewed changes

Comment thread .github/workflows/api-docs.yml Outdated

M. Emin Cihangeri and others added 17 commits April 8, 2026 11:38

chore: Use one step to get the variables e.g. version

cdbbd3a

Update .github/workflows/api-docs.yml

a3ea84d

Co-authored-by: Marika Marszalkowski <marika.marszalkowski@sap.com>

Merge branch 'main' into chore-separate-docs-prs

3bdec9b

chore: Remove unnecessary comment

61c4aef

Merge branch 'main' into chore-separate-docs-prs

79ad502

chore: Remove duplicate token

780a8d6

chore: Use client id

816dff3

Merge branch 'main' into chore-separate-docs-prs

3572db1

chore: Checkout later

b673adf

chore: Check if there are changes

53f40bb

chore: Make sensitive to the full version

6af3850

Merge branch 'main' into chore-separate-docs-prs

082f526

chore: Remove checkout path

8fd0ca9

chore: Rechange the version passing

7a422f3

chore: Add path to checkout

44e30d2

chore: Use ai-sdk bot name and email

016abd9

chore: Change the git operation order

86e3f0e

marikaner requested changes Apr 16, 2026

View reviewed changes

emincihangeri and others added 4 commits April 16, 2026 11:35

Update .github/workflows/api-docs.yml

a956bd3

Co-authored-by: Marika Marszalkowski <marika.marszalkowski@sap.com>

Merge branch 'main' into chore-separate-docs-prs

457391d

chore: Remove unvalid variables and clean up

a9cddd5

Merge branch 'main' into chore-separate-docs-prs

eecd286

marikaner added 2 commits April 23, 2026 11:30

Apply suggestion from @marikaner

4a92f92

Revert "Apply suggestion from @marikaner"

aa90e78

This reverts commit 4a92f92.

marikaner requested changes Apr 23, 2026

View reviewed changes

Comment thread .github/workflows/bump.yml Outdated

Comment thread .github/workflows/bump.yml Outdated

Comment thread .github/workflows/api-docs.yml Outdated

Comment thread .github/workflows/bump.yml Outdated

marikaner reviewed Apr 23, 2026

View reviewed changes

emincihangeri and others added 2 commits April 23, 2026 13:32

Update .github/workflows/bump.yml

bc3d44a

Co-authored-by: Marika Marszalkowski <marika.marszalkowski@sap.com>

Update .github/workflows/bump.yml

2450eee

Co-authored-by: Marika Marszalkowski <marika.marszalkowski@sap.com>

emincihangeri added 2 commits April 23, 2026 15:08

chore: Create a reusable action for creating PR

f8b34a5

chore: Fix indentation

58991b5

marikaner requested changes Apr 24, 2026

View reviewed changes

davidkna-sap and others added 7 commits April 27, 2026 16:20

Merge branch 'main' into chore-separate-docs-prs

88f2990

Update .github/actions/create-api-docs-pr/action.yml

9c375d2

Co-authored-by: Marika Marszalkowski <marika.marszalkowski@sap.com>

Update .github/actions/create-api-docs-pr/action.yml

45cf319

Co-authored-by: Marika Marszalkowski <marika.marszalkowski@sap.com>

Update .github/workflows/bump.yml

3c37d65

Co-authored-by: Marika Marszalkowski <marika.marszalkowski@sap.com>

Merge branch 'main' into chore-separate-docs-prs

51d19dc

chore: Clean unnecessary parts

a0ce1d4

Merge branch 'main' into chore-separate-docs-prs

26a3e9d

davidkna-sap reviewed May 5, 2026

View reviewed changes

emincihangeri and others added 7 commits May 6, 2026 10:27

Merge branch 'main' into chore-separate-docs-prs

e0776cc

Update .github/actions/create-api-docs-pr/action.yml

9c397dc

Co-authored-by: David Knaack <david.knaack@sap.com>

Update .github/actions/create-api-docs-pr/action.yml

20ddebd

Co-authored-by: David Knaack <david.knaack@sap.com>

Update .github/workflows/publish-release.yml

b7cb226

Co-authored-by: David Knaack <david.knaack@sap.com>

chore: Use env variables instead of inline expressions

238b0d4

Merge branch 'main' into chore-separate-docs-prs

0eabbeb

Merge branch 'main' into chore-separate-docs-prs

6125d7d

marikaner approved these changes May 7, 2026

View reviewed changes

marikaner merged commit 7898a5a into main May 7, 2026
14 checks passed

marikaner deleted the chore-separate-docs-prs branch May 7, 2026 08:08

Conversation

emincihangeri commented Apr 7, 2026

Context

What this PR does and why it is needed

Uh oh!

hyperspace-insights Bot commented Apr 7, 2026

Summary

Separate API Docs PR from Release Notes Workflow

Refactor

Changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

marikaner left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

marikaner left a comment

Choose a reason for hiding this comment

Uh oh!

emincihangeri commented Apr 23, 2026

Uh oh!

marikaner left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

davidkna-sap left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

marikaner left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

davidkna-sap left a comment •

edited

Loading