Skip to content

Commit 08cc1f6

Browse files
chore(bigframes): document release procedure using legacylibrarian (#17436)
Fixes #<522923981> 🦕 --------- Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
1 parent a6970c8 commit 08cc1f6

1 file changed

Lines changed: 51 additions & 0 deletions

File tree

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
# BigQuery DataFrames (bigframes) release procedure
2+
3+
*(Note: bigframes releases are marked with `skip_release: true` in `librarian.yaml` and must be kicked off manually using legacylibrarian.)*
4+
5+
## Setup (First Time Only)
6+
7+
* Install `legacylibrarian`:
8+
9+
go install github.com/googleapis/librarian/cmd/legacylibrarian@latest
10+
11+
* Authenticate with GitHub CLI:
12+
13+
gh auth login
14+
15+
## Release Steps
16+
17+
* Obtain GitHub token:
18+
19+
export LIBRARIAN_GITHUB_TOKEN=$(gh auth token)
20+
21+
* Stash changes (repo must be clean):
22+
23+
git stash -u
24+
25+
* Fetch and checkout base:
26+
27+
git fetch origin main
28+
git fetch origin --tags
29+
git checkout origin/main
30+
31+
* Check image updates:
32+
33+
legacylibrarian update-image --push
34+
35+
* Create release PR:
36+
37+
# Option A: Push directly
38+
legacylibrarian release stage --repo=https://github.com/googleapis/google-cloud-python --library=bigframes --library-version=X.X.X --push
39+
40+
# Option B: Manual edit first (omit --push, edit files in /tmp/librarian-*, commit/push from there)
41+
legacylibrarian release stage --repo=https://github.com/googleapis/google-cloud-python --library=bigframes --library-version=X.X.X
42+
# In /tmp repository:
43+
git commit -a -m "chore: create release" --no-verify # keep librarian config pristine
44+
git push origin HEAD
45+
gh pr create --fill --label "release:pending"
46+
47+
* Post-release restore:
48+
49+
# Move back any stashed/relocated files (like .vscode)
50+
git checkout main
51+
git stash pop

0 commit comments

Comments
 (0)