Skip to content

Commit c61fa7f

Browse files
authored
Fix Weave reference docs workflow to always base new branches on main (#1947)
The create-pull-request action was missing the 'base' parameter, which meant new branches weren't guaranteed to be created from the latest main. This caused update-reference-docs branches to be based on stale commits (e.g., 155 commits behind), resulting in corrupted docs.json missing integrations and other configuration. Adding 'base: main' ensures each new PR branch is created fresh from the latest main commit.
1 parent bd3afbc commit c61fa7f

File tree

3 files changed

+5
-2
lines changed

3 files changed

+5
-2
lines changed

.github/workflows/generate-weave-reference-docs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -133,6 +133,7 @@ jobs:
133133
uses: peter-evans/create-pull-request@v7
134134
with:
135135
token: ${{ secrets.GITHUB_TOKEN }}
136+
base: main
136137
commit-message: "chore: Update reference documentation (Weave ${{ steps.python-sdk.outputs.actual_version || steps.version.outputs.version }})"
137138
title: "Update Weave reference documentation (Weave ${{ steps.python-sdk.outputs.actual_version || steps.version.outputs.version }})"
138139
draft: true

.github/workflows/update-service-api.yml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,9 +74,10 @@ jobs:
7474
uses: peter-evans/create-pull-request@v7
7575
with:
7676
token: ${{ secrets.GITHUB_TOKEN }}
77+
base: main
7778
commit-message: "chore: Update Service API documentation"
7879
title: "Update Service API documentation"
79-
draft: false
80+
draft: true
8081
body: |
8182
This PR updates the Service API documentation based on the latest OpenAPI specification.
8283

.github/workflows/update-training-api.yml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,9 +72,10 @@ jobs:
7272
uses: peter-evans/create-pull-request@v7
7373
with:
7474
token: ${{ secrets.GITHUB_TOKEN }}
75+
base: main
7576
commit-message: "chore: Update Training API documentation"
7677
title: "Update Training API documentation"
77-
draft: false
78+
draft: true
7879
body: |
7980
This PR updates the Training API documentation based on the latest OpenAPI specification.
8081

0 commit comments

Comments
 (0)