docs: Update examples to be clusterctl templates #719
Workflow file for this run
This file contains 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 2023 D2iQ, Inc. All rights reserved. | |
| # SPDX-License-Identifier: Apache-2.0 | |
| # Sample workflow for building and deploying a Hugo site to GitHub Pages | |
| name: Deploy Hugo site to Pages | |
| on: | |
| # Runs on pushes targeting the default branch | |
| push: | |
| branches: | |
| - main | |
| pull_request: | |
| # Allows you to run this workflow manually from the Actions tab | |
| workflow_dispatch: | |
| # Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages | |
| permissions: | |
| contents: read | |
| pages: write | |
| id-token: write | |
| # Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued. | |
| # However, do NOT cancel in-progress runs as we want to allow these production deployments to complete. | |
| concurrency: | |
| group: "pages" | |
| cancel-in-progress: false | |
| # Default to bash | |
| defaults: | |
| run: | |
| shell: bash | |
| jobs: | |
| # Build job | |
| build: | |
| runs-on: ubuntu-22.04 | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v4 | |
| - name: Install devbox | |
| uses: jetpack-io/devbox-install-action@v0.8.0 | |
| with: | |
| enable-cache: true | |
| - name: Setup Pages | |
| id: pages | |
| uses: actions/configure-pages@v4 | |
| - name: Install Node.js dependencies | |
| run: if [[ -f package-lock.json || -f npm-shrinkwrap.json ]]; then npm ci; fi | |
| working-directory: docs | |
| - name: Update Helm index | |
| env: | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| run: | | |
| mapfile -t releases < <( devbox run -- gh release list --json tagName | devbox run -- gojq -r .[].tagName ) | |
| for release in "${releases[@]}"; do | |
| if devbox run -- gh release download "${release}" \ | |
| --pattern 'capi-runtime-extensions-*.tgz' \ | |
| --dir docs/static/helm 2>/dev/null; then | |
| devbox run -- helm repo index docs/static/helm \ | |
| --url "https://github.com/${{ github.repository }}/releases/download/${release}" \ | |
| --merge docs/static/helm/index.yaml | |
| rm -f docs/static/helm/*.tgz | |
| fi | |
| done | |
| - name: Build with Hugo | |
| env: | |
| # For maximum backward compatibility with Hugo modules | |
| HUGO_ENVIRONMENT: production | |
| HUGO_ENV: production | |
| BASE_URL: "${{ steps.pages.outputs.base_url }}/" | |
| run: devbox run -- build-docs | |
| - name: Upload artifact | |
| if: github.ref == 'refs/heads/main' | |
| uses: actions/upload-pages-artifact@v3 | |
| with: | |
| path: ./docs/public | |
| # Deployment job | |
| deploy: | |
| environment: | |
| name: github-pages | |
| url: ${{ steps.deployment.outputs.page_url }} | |
| runs-on: ubuntu-22.04 | |
| needs: build | |
| if: github.ref == 'refs/heads/main' | |
| steps: | |
| - name: Deploy to GitHub Pages | |
| id: deployment | |
| uses: actions/deploy-pages@v4 |