Skip to content

Commit bc9ecdb

Browse files
authored
docs(bigframes): Resume deployment to GitHub Pages (googleapis#16974)
Tested manually at https://github.com/tswast/google-cloud-python/actions/runs/25460952016 and http://tswast.github.io/google-cloud-python/ Fixes #<issue_number_goes_here> 🦕
1 parent 3bf9371 commit bc9ecdb

1 file changed

Lines changed: 65 additions & 0 deletions

File tree

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
name: Deploy BigFrames docs to GitHub Pages
2+
3+
on:
4+
# Runs on pushes targeting the default branch
5+
push:
6+
branches: ["main"]
7+
paths:
8+
- "packages/bigframes/docs/**"
9+
- ".github/workflows/bigframes-docs-deploy.yaml"
10+
11+
# Allows you to run this workflow manually from the Actions tab
12+
workflow_dispatch:
13+
14+
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
15+
permissions:
16+
contents: read
17+
pages: write
18+
id-token: write
19+
20+
# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
21+
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
22+
concurrency:
23+
group: "pages"
24+
cancel-in-progress: false
25+
26+
jobs:
27+
# Build job
28+
build:
29+
runs-on: ubuntu-latest
30+
steps:
31+
- name: Checkout
32+
uses: actions/checkout@v6
33+
# Use a fetch-depth of 2 to avoid error `fatal: origin/main...HEAD: no merge base`
34+
# See https://github.com/googleapis/google-cloud-python/issues/12013
35+
# and https://github.com/actions/checkout#checkout-head.
36+
with:
37+
fetch-depth: 2
38+
- name: Setup Python
39+
uses: actions/setup-python@v6
40+
with:
41+
python-version: "3.10"
42+
- name: Install nox
43+
run: |
44+
python -m pip install --upgrade setuptools pip wheel
45+
python -m pip install nox
46+
- name: Run docs
47+
working-directory: ./packages/bigframes
48+
run: |
49+
nox -s docs
50+
- name: Upload artifact
51+
uses: actions/upload-pages-artifact@v5
52+
with:
53+
path: packages/bigframes/docs/_build/html/
54+
55+
# Deployment job
56+
deploy:
57+
environment:
58+
name: github-pages
59+
url: ${{ steps.deployment.outputs.page_url }}
60+
runs-on: ubuntu-latest
61+
needs: build
62+
steps:
63+
- name: Deploy to GitHub Pages
64+
id: deployment
65+
uses: actions/deploy-pages@v5

0 commit comments

Comments
 (0)