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.

marikaner · 2026-04-08T06:20:44Z

    inputs:
      version:
-        description: 'Version to generate docs for (e.g., 2.9.0). Only the major version is used for the target folder (e.g., v2).'
+        description: 'Version to generate docs for (e.g., 2.9.0).'


[q] Why do we even have to pass a version? Can't we take what is in the package.json?

This could be useful in very rare cases that there is something needs to be fixed in the API docs after a bump for a specific version but I am not sure if it is a must. :/

Then this could be an optional field.

[req] You need to handle the case if nothing was passed still. I think there is a script to get the version from package.json. If not, I think this can be very easily be done on the command line.

Otherwise, this is the result: SAP/ai-sdk#459

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>

marikaner · 2026-04-23T07:36:24Z

    inputs:
      version:
-        description: 'Version to generate docs for (e.g., 2.9.0). Only the major version is used for the target folder (e.g., v2).'
+        description: 'Version to generate docs for (e.g., 2.9.0).'


[req] You need to handle the case if nothing was passed still. I think there is a script to get the version from package.json. If not, I think this can be very easily be done on the command line.

marikaner · 2026-04-23T07:38:06Z

    inputs:
      version:
-        description: 'Version to generate docs for (e.g., 2.9.0). Only the major version is used for the target folder (e.g., v2).'
+        description: 'Version to generate docs for (e.g., 2.9.0).'


Otherwise, this is the result: SAP/ai-sdk#459

This reverts commit 4a92f92.

marikaner · 2026-04-23T10:59:32Z

    inputs:
      version:
-        description: 'Version to generate docs for (e.g., 2.9.0). Only the major version is used for the target folder (e.g., v2).'
+        description: 'Version to generate docs for (e.g., 2.9.0).'
        required: true
        type: string


[req] After reviewing this once more, I noticed that you don't use the version for anything different than the branch name and title of the PR and commit. As discussed, you fixed this for the workflow_dispatch, but not the workflow_call.
When you call the workflow from bump as is right now, yes, you are not running on the bumped version, but on the state of main pre bump (https://docs.github.com/en/enterprise-server@3.19/actions/how-tos/reuse-automations/reuse-workflows?utm_source=chatgpt.com#calling-a-reusable-workflow). But changing the title of the api-docs commit, won't change that.

See my comments in bump for suggestions.

marikaner · 2026-04-23T11:13:58Z

+  generate-api-docs:
+    name: Generate and Push API Documentation
+    needs: [bump]
+    uses: ./.github/workflows/api-docs.yml
+    secrets: inherit
+    with:
+      version: ${{ needs.bump.outputs.version }}


[req] AFAIK you have 2 options:

Call the workflow using the gh cli.

trigger the workflow on push to the tag: https://docs.github.com/en/enterprise-server@3.19/actions/reference/workflows-and-actions/workflow-syntax?utm_source=chatgpt.com&versionId=enterprise-server%403.19&productId=actions&restPage=how-tos%2Creuse-automations%2Creuse-workflows#example-including-branches-and-tags

I tried to implement with the 2nd option now. Looks more clean.

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.

marikaner · 2026-04-24T05:35:48Z

+        if git commit -m 'Update SAP AI SDK for JavaScript API documentation v${{ steps.version.outputs.major-version }}'; then
+          git push -u origin "$BRANCH_NAME"
+          echo "pushed=true" >> "$GITHUB_OUTPUT"
+        else
+          echo "No changes to commit. Skipping push."
+          echo "pushed=false" >> "$GITHUB_OUTPUT"
+        fi


[req] I think the if else conditions here are redundant. We already have the check whether there are changes. If there are no changes, we never enter this step. So it would suffice to do the if block and not create a GITHUB_OUTPUT.

marikaner · 2026-04-24T05:35:59Z

+        fi
+
+    - name: Create pull request
+      if: steps.check-changes.outputs.docs == 'true' && steps.commit-push.outputs.pushed == 'true'


Suggested change

if: steps.check-changes.outputs.docs == 'true' && steps.commit-push.outputs.pushed == 'true'

if: steps.check-changes.outputs.docs == 'true'

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

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

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

emincihangeri and others added 2 commits April 22, 2026 15:03

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

5efd98a

chore: Match job ids

fc43945

marikaner requested changes Apr 23, 2026

View reviewed changes

emincihangeri and others added 3 commits April 23, 2026 09:55

chore: Set version number when not provided

1502aad

chore: Remove the input parameter for workflow_dispatch

ee02ab7

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

021cac7

marikaner reviewed Apr 23, 2026

View reviewed changes

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

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

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 6 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

	if: steps.check-changes.outputs.docs == 'true' && steps.commit-push.outputs.pushed == 'true'
	if: steps.check-changes.outputs.docs == 'true'

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!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

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!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

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!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants