Skip to content

Commit 575834f

Browse files
committed
docs: add release-procedure.md
1 parent 8210113 commit 575834f

1 file changed

Lines changed: 36 additions & 0 deletions

File tree

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# BigQuery DataFrames (bigframes) release procedure
2+
3+
* Obtain GitHub token:
4+
5+
export LIBRARIAN_GITHUB_TOKEN=$(gh auth token)
6+
7+
* Stash changes (repo must be clean):
8+
9+
git stash -u
10+
11+
* Fetch and checkout base:
12+
13+
git fetch origin main
14+
git fetch origin --tags
15+
git checkout origin/main
16+
17+
* Check image updates:
18+
19+
legacylibrarian update-image -push
20+
21+
* Create release PR:
22+
23+
# Option A: Push directly
24+
legacylibrarian release stage --repo=https://github.com/googleapis/google-cloud-python --library=bigframes --library-version=X.X.X --push
25+
26+
# Option B: Manual edit first (omit -push, edit files in /tmp/librarian-*, commit/push from there)
27+
legacylibrarian release stage --repo=https://github.com/googleapis/google-cloud-python --library=bigframes --library-version=X.X.X
28+
# In /tmp repository:
29+
git commit -a -m "chore: create release" --no-verify # keep librarian config pristine
30+
# Push branch & create PR on GitHub with release:pending label
31+
32+
* Post-release restore:
33+
34+
# Move back any stashed/relocated files (like .vscode)
35+
git checkout main
36+
git stash pop

0 commit comments

Comments
 (0)