chore: Add workflows to deploy to cloudflare #1
Workflow file for this run
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| # 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: "CF: Deploy PR Preview" | |
| permissions: | |
| contents: read | |
| 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 with preview cleanup. | |
| group: "cf-preview-${{ github.event.number }}" | |
| cancel-in-progress: true | |
| steps: | |
| - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6 | |
| with: | |
| # Check out the fork repository explicitly if it's a fork PR | |
| ref: ${{ github.event.pull_request.head.sha }} | |
| fetch-depth: 0 # Fetch all history for .GitInfo and .Lastmod | |
| - name: Patch Config and Templates for Cloudflare | |
| run: | | |
| # Strip GitHub domain from config | |
| sed -i 's|https://googleapis.github.io/genai-toolbox/|/|g' hugo.toml | |
| # Strip prefix from navbar partial | |
| if [ -f "layouts/partials/navbar-version-selector.html" ]; then | |
| sed -i 's|/genai-toolbox/|/|g' layouts/partials/navbar-version-selector.html | |
| fi | |
| # Disable the migration banner for the CF preview site | |
| if [ -f "static/js/migration-banner.js" ]; then | |
| echo "" > static/js/migration-banner.js | |
| fi | |
| - name: Setup Hugo | |
| uses: peaceiris/actions-hugo@75d2e84710de30f6ff7268e08f310b60ef14033f # v3 | |
| with: | |
| hugo-version: "0.145.0" | |
| extended: true | |
| - name: Setup Node | |
| uses: actions/setup-node@6044e13b5dc448c55e2357c09f80417699197238 # v6 | |
| with: | |
| node-version: "22" | |
| - name: Cache dependencies | |
| uses: actions/cache@cdf6c1fa76f9f475f3d7449005a359c84ca0f306 # v5 | |
| 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: "/" | |
| HUGO_ENVIRONMENT: preview | |
| HUGO_RELATIVEURLS: true | |
| - name: Deploy to Cloudflare Pages via Wrangler | |
| id: cf_deploy | |
| uses: cloudflare/wrangler-action@v3 | |
| with: | |
| apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }} | |
| accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }} | |
| command: pages deploy .hugo/public --project-name toolbox-docs --branch pr-${{ github.event.number }} | |
| - 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: "🚀 **Cloudflare Preview is building!**\n\n🔎 View Preview: ${{ steps.cf_deploy.outputs.pages-deployment-alias-url }}\n\n*(Note: It may take a minute or two for Cloudflare to finish deploying the branch)*" | |
| }) |