mirror of
https://github.com/googleapis/genai-toolbox.git
synced 2026-04-09 03:02:26 -04:00
0f6d52a225
## Description --- This PR moves the deployement of the PR Previews to the newly created versioned-gh-pages branch which hosts the versioned doc site. ## PR Checklist --- > Thank you for opening a Pull Request! Before submitting your PR, there are a > few things you can do to make sure it goes smoothly: - [x] Make sure you reviewed [CONTRIBUTING.md](https://github.com/googleapis/genai-toolbox/blob/main/CONTRIBUTING.md) - [ ] Make sure to open an issue as a [bug/issue](https://github.com/googleapis/genai-toolbox/issues/new/choose) before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea - [x] Ensure the tests and linter pass - [x] Code coverage does not decrease (if any source code was changed) - [x] Appropriate docs were updated (if necessary) - [x] Make sure to add `!` if this involve a breaking change 🛠️ Fixes #<issue_number_goes_here>
103 lines
3.7 KiB
YAML
103 lines
3.7 KiB
YAML
# Copyright 2025 Google LLC
|
|
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
# you may not use this file except in compliance with the License.
|
|
# You may obtain a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
# See the License for the specific language governing permissions and
|
|
# limitations under the License.
|
|
|
|
name: "docs"
|
|
|
|
permissions:
|
|
contents: write
|
|
pull-requests: write
|
|
|
|
# This Workflow depends on 'github.event.number',
|
|
# not compatible with branch or manual triggers.
|
|
on:
|
|
pull_request:
|
|
# Sync with github_actions_preview_fallback.yml on.pull_request.paths-ignore
|
|
paths:
|
|
- 'docs/**'
|
|
- 'github/workflows/docs**'
|
|
- '.hugo/**'
|
|
pull_request_target:
|
|
types: [labeled]
|
|
paths:
|
|
- 'docs/**'
|
|
- 'github/workflows/docs**'
|
|
- '.hugo/**'
|
|
|
|
jobs:
|
|
preview:
|
|
# run job on proper workflow event triggers (skip job for pull_request event
|
|
# from forks and only run pull_request_target for "docs: deploy-preview"
|
|
# label)
|
|
if: "${{ (github.event.action != 'labeled' && github.event.pull_request.head.repo.full_name == github.event.pull_request.base.repo.full_name) || github.event.label.name == 'docs: deploy-preview' }}"
|
|
runs-on: ubuntu-24.04
|
|
defaults:
|
|
run:
|
|
working-directory: .hugo
|
|
concurrency:
|
|
# Shared concurrency group wih preview cleanup.
|
|
group: "preview-${{ github.event.number }}"
|
|
cancel-in-progress: true
|
|
steps:
|
|
- uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5
|
|
with:
|
|
# Checkout the PR's HEAD commit (supports forks).
|
|
ref: ${{ github.event.pull_request.head.sha }}
|
|
fetch-depth: 0 # Fetch all history for .GitInfo and .Lastmod
|
|
|
|
- name: Setup Hugo
|
|
uses: peaceiris/actions-hugo@75d2e84710de30f6ff7268e08f310b60ef14033f # v3
|
|
with:
|
|
hugo-version: "0.145.0"
|
|
extended: true
|
|
|
|
- name: Setup Node
|
|
uses: actions/setup-node@a0853c24544627f65ddf259abe73b1d18a591444 # v5
|
|
with:
|
|
node-version: "22"
|
|
|
|
- name: Cache dependencies
|
|
uses: actions/cache@0400d5f644dc74513175e3cd8d07132dd4860809 # v4
|
|
with:
|
|
path: ~/.npm
|
|
key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
|
|
restore-keys: |
|
|
${{ runner.os }}-node-
|
|
|
|
- run: npm ci
|
|
- run: hugo --minify
|
|
env:
|
|
HUGO_BASEURL: https://${{ github.repository_owner }}.github.io/${{ github.event.repository.name }}/previews/PR-${{ github.event.number }}/
|
|
HUGO_ENVIRONMENT: preview
|
|
HUGO_RELATIVEURLS: false
|
|
|
|
- name: Deploy
|
|
uses: peaceiris/actions-gh-pages@4f9cc6602d3f66b9c108549d475ec49e8ef4d45e # v4
|
|
with:
|
|
github_token: ${{ secrets.GITHUB_TOKEN }}
|
|
publish_dir: .hugo/public
|
|
publish_branch: versioned-gh-pages
|
|
destination_dir: ./previews/PR-${{ github.event.number }}
|
|
commit_message: "stage: PR-${{ github.event.number }}: ${{ github.event.head_commit.message }}"
|
|
|
|
- name: Comment
|
|
uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8
|
|
with:
|
|
script: |
|
|
github.rest.issues.createComment({
|
|
issue_number: context.payload.number,
|
|
owner: context.repo.owner,
|
|
repo: context.repo.repo,
|
|
body: "🔎 Preview at https://${{ github.repository_owner }}.github.io/${{ github.event.repository.name }}/previews/PR-${{ github.event.number }}/"
|
|
})
|