Skip to content

docs: document release procedure using legacylibrarian #17436

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
shuoweil wants to merge 6 commits into
base: main
Choose a base branch
from
+51 −0
Open

docs: document release procedure using legacylibrarian #17436

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
575834f
docs: add release-procedure.md
shuoweil Jun 9, 2026
e895e89
Merge branch 'main' into shuowei-skill-release
shuoweil Jun 11, 2026
1fe38be
docs: add RELEASING.md onboarding guide
shuoweil Jun 11, 2026
d5ff8ff
docs: merge onboarding guide into release-procedure.md
shuoweil Jun 11, 2026
6db96f4
Update packages/bigframes/release-procedure.md
shuoweil Jun 11, 2026
33e1912
Update packages/bigframes/release-procedure.md
shuoweil Jun 11, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
51 changes: 51 additions & 0 deletions packages/bigframes/release-procedure.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
# BigQuery DataFrames (bigframes) release procedure

*(Note: bigframes releases are marked with `skip_release: true` in `librarian.yaml` and must be kicked off manually using legacylibrarian.)*

## Setup (First Time Only)

* Install `legacylibrarian`:

go install github.com/googleapis/librarian/cmd/legacylibrarian@latest

* Authenticate with GitHub CLI:

gh auth login

## Release Steps

* Obtain GitHub token:

export LIBRARIAN_GITHUB_TOKEN=$(gh auth token)

* Stash changes (repo must be clean):

git stash -u

* Fetch and checkout base:

git fetch origin main
git fetch origin --tags
git checkout origin/main

* Check image updates:

legacylibrarian update-image --push

* Create release PR:

# Option A: Push directly
legacylibrarian release stage --repo=https://github.com/googleapis/google-cloud-python --library=bigframes --library-version=X.X.X --push

# Option B: Manual edit first (omit --push, edit files in /tmp/librarian-*, commit/push from there)
legacylibrarian release stage --repo=https://github.com/googleapis/google-cloud-python --library=bigframes --library-version=X.X.X
# In /tmp repository:
git commit -a -m "chore: create release" --no-verify # keep librarian config pristine
git push origin HEAD
gh pr create --fill --label "release:pending"

* Post-release restore:

# Move back any stashed/relocated files (like .vscode)
git checkout main
git stash pop
Loading