fix: remove escape sequence char to remove warning #55
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
| # Sample workflow for building and deploying a MkDocs site to GitHub Pages | |
| name: Deploy MkDocs with GitHub Pages dependencies preinstalled | |
| on: | |
| # Runs on pushes targeting the default branch | |
| push: | |
| branches: ["main", "v.*"] | |
| # 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: write | |
| pages: write | |
| id-token: write | |
| # Allow one concurrent deployment | |
| concurrency: | |
| group: "pages" | |
| cancel-in-progress: true | |
| jobs: | |
| test: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v4 | |
| - run: script/test | |
| # Build job | |
| build: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 0 | |
| - name: Setup Pages | |
| uses: actions/configure-pages@v5 | |
| - name: Setup Python | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: "3.11" | |
| - name: Install MkDocs and Material for MkDocs | |
| run: pip install mkdocs[i18n] mkdocs-material | |
| - name: Install Pillow and CairoSVG (required for social card generation) | |
| run: pip install mkdocs-material | |
| - name: Setup caching | |
| uses: actions/cache@v4 | |
| with: | |
| key: ${{ github.sha }} | |
| path: .cache | |
| - name: Build site (_site directory name is used for Jekyll compatiblity) | |
| run: mkdocs build --config-file ./mkdocs.yaml --site-dir ./_site | |
| - name: Upload artifact | |
| uses: actions/upload-pages-artifact@v3 | |
| release: | |
| needs: | |
| - build | |
| - test | |
| name: Release | |
| runs-on: ubuntu-latest | |
| env: | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| steps: | |
| - uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 0 | |
| - uses: open-turo/actions-gha/release@v2 | |
| # Deployment job | |
| deploy: | |
| environment: | |
| name: github-pages | |
| url: ${{ steps.deployment.outputs.page_url }} | |
| runs-on: ubuntu-latest | |
| needs: | |
| - release | |
| steps: | |
| - name: Deploy to GitHub Pages | |
| id: deployment | |
| uses: actions/deploy-pages@v4 |