Fix typo in documentation (#275) #103
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
| name: Deploy to GitHub Pages | |
| on: | |
| push: | |
| branches: | |
| - main | |
| workflow_dispatch: | |
| inputs: | |
| dev_branch: | |
| description: 'Change the build branch for deployment to personal website for PR previewing' | |
| required: false | |
| default: 'main' | |
| type: string | |
| jobs: | |
| deploy: | |
| name: Deploy to GitHub Pages | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v3 | |
| with: | |
| ref: ${{ github.event.inputs.dev_branch }} | |
| - uses: actions/setup-node@v4 | |
| with: | |
| node-version: 18 | |
| cache: yarn | |
| - name: Install dependencies | |
| run: yarn install --frozen-lockfile | |
| - name: Build website | |
| if: ${{ github.repository_owner == 'k3s-io' }} | |
| run: yarn build | |
| # Developer build used for PR reviews, deploys website with with a custom `baseUrl` for previewing | |
| - name: Build website (dev) | |
| if: ${{ github.repository_owner != 'k3s-io' && github.event_name == 'workflow_dispatch' }} | |
| run: | | |
| echo "replacing baseUrl in docusaurus.config.js with ${{ github.event.repository.name }}" | |
| sed -i 's/baseUrl: '\''\//baseUrl: '\''\/${{ github.event.repository.name }}/' docusaurus.config.js | |
| yarn build | |
| # Popular action to deploy to GitHub Pages: | |
| # Docs: https://github.com/peaceiris/actions-gh-pages#%EF%B8%8F-docusaurus | |
| - name: Deploy to GitHub Pages | |
| uses: peaceiris/actions-gh-pages@v3 | |
| with: | |
| github_token: ${{ secrets.GITHUB_TOKEN }} | |
| cname: docs.k3s.io | |
| # Build output to publish to the `gh-pages` branch: | |
| publish_dir: ./build | |
| # The following lines assign commit authorship to the official | |
| # GH-Actions bot for deploys to `gh-pages` branch: | |
| # https://github.com/actions/checkout/issues/13#issuecomment-724415212 | |
| user_name: github-actions[bot] | |
| user_email: 41898282+github-actions[bot]@users.noreply.github.com |