(docs) Add related projects #41
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 MkDocs with GitHub Pages dependencies preinstalled | |
| on: | |
| push: | |
| branches: ['main'] | |
| # 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 | |
| jobs: | |
| build_and_upload: | |
| name: 'Build docs and upload artifact' | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v4 | |
| - name: Build ESP binaries | |
| uses: ./.github/actions/build-esp | |
| - name: Setup Pages | |
| uses: actions/configure-pages@v4 | |
| - name: Setup Python | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: '3.x' | |
| cache: 'pip' | |
| - name: Install required packages | |
| run: pip install -r requirements.txt | |
| # TODO Maybe cache the `.cache` folder? It doesn't seem to be generated though | |
| - name: Build site | |
| # `_site` directory name is used for Jekyll compatiblity, see https://github.com/actions/upload-pages-artifact/blob/main/action.yml#L12 | |
| run: mkdocs build --config-file ./mkdocs.yml --site-dir ./_site | |
| - name: Upload artifact | |
| uses: actions/upload-pages-artifact@v2 | |
| deploy: | |
| name: 'Deploy to GitHub Pages' | |
| environment: | |
| name: github-pages | |
| url: ${{ steps.deployment.outputs.page_url }} | |
| runs-on: ubuntu-latest | |
| needs: build_and_upload | |
| steps: | |
| - name: Deploy to GitHub Pages | |
| id: deployment | |
| uses: actions/deploy-pages@v3 |