mirror of
https://github.com/googleapis/genai-toolbox.git
synced 2026-04-09 03:02:26 -04:00
21ac98bc06
## Description --- This PR adds related configs and workflows required for document versioning. ## 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>
104 lines
3.4 KiB
YAML
104 lines
3.4 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: "Deploy Previous Version Docs"
|
|
|
|
on:
|
|
workflow_dispatch:
|
|
inputs:
|
|
version_tag:
|
|
description: 'The old version tag to build docs for (e.g., v0.15.0)'
|
|
required: true
|
|
type: string
|
|
|
|
jobs:
|
|
build_and_deploy:
|
|
runs-on: ubuntu-latest
|
|
permissions:
|
|
contents: write
|
|
|
|
steps:
|
|
- name: Checkout main branch (for latest templates and theme)
|
|
uses: actions/checkout@v4
|
|
with:
|
|
ref: 'main'
|
|
submodules: 'recursive'
|
|
fetch-depth: 0
|
|
|
|
- name: Checkout old content from tag into a temporary directory
|
|
uses: actions/checkout@v4
|
|
with:
|
|
ref: ${{ github.event.inputs.version_tag }}
|
|
path: 'old_version_source' # Checkout into a temp subdir
|
|
# Sparse checkout to only get the content directory
|
|
sparse-checkout: |
|
|
docs
|
|
|
|
- name: Replace content with old version
|
|
run: |
|
|
# Remove the current content directory from the main branch checkout
|
|
rm -rf docs/
|
|
# Move the old content directory into place
|
|
mv ./old_version_source/docs docs
|
|
|
|
- name: Setup Hugo and Node
|
|
uses: peaceiris/actions-hugo@v3
|
|
with:
|
|
hugo-version: "0.145.0"
|
|
extended: true
|
|
- uses: actions/setup-node@v4
|
|
with:
|
|
node-version: "22"
|
|
|
|
- name: Install Dependencies
|
|
run: npm ci
|
|
working-directory: .hugo
|
|
|
|
- name: Build Hugo Site for Archived Version
|
|
run: hugo --minify
|
|
working-directory: .hugo
|
|
env:
|
|
HUGO_BASEURL: https://${{ github.repository_owner }}.github.io/${{ github.event.repository.name }}/${{ github.event.inputs.version_tag }}/
|
|
HUGO_RELATIVEURLS: false
|
|
|
|
- name: Deploy to gh-pages
|
|
uses: peaceiris/actions-gh-pages@v4
|
|
with:
|
|
github_token: ${{ secrets.GITHUB_TOKEN }}
|
|
publish_dir: .hugo/public
|
|
publish_branch: versioned-gh-pages
|
|
destination_dir: ./${{ github.event.inputs.version_tag }}
|
|
keep_files: true
|
|
allow_empty_commit: true
|
|
commit_message: "docs(backport): deploy docs for ${{ github.event.inputs.version_tag }}"
|
|
|
|
- name: Clean Build Directory
|
|
run: rm -rf .hugo/public
|
|
|
|
- name: Build Hugo Site
|
|
run: hugo --minify
|
|
working-directory: .hugo
|
|
env:
|
|
HUGO_BASEURL: https://${{ github.repository_owner }}.github.io/${{ github.event.repository.name }}/
|
|
HUGO_RELATIVEURLS: false
|
|
|
|
- name: Deploy to root
|
|
uses: peaceiris/actions-gh-pages@v4
|
|
with:
|
|
github_token: ${{ secrets.GITHUB_TOKEN }}
|
|
publish_dir: .hugo/public
|
|
publish_branch: versioned-gh-pages
|
|
keep_files: true
|
|
allow_empty_commit: true
|
|
commit_message: "deploy: docs to root for ${{ github.event.inputs.version_tag }}" |