Initial commit #1
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: "🚀 Deployment" | |
| on: | |
| push: | |
| branches: | |
| - main | |
| paths: | |
| - ".github/workflows/deploy.yml" | |
| - "config/*.yml" | |
| - "content/**" | |
| - "mkdocs.yml" | |
| - "requirements*.txt" | |
| workflow_dispatch: | |
| # Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages | |
| permissions: | |
| contents: read | |
| pages: write | |
| id-token: write | |
| # Allow one concurrent deployment | |
| concurrency: | |
| group: "pages" | |
| cancel-in-progress: true | |
| jobs: | |
| deploy: | |
| name: "📤 GitHub Pages" | |
| runs-on: ubuntu-latest | |
| if: ${{ github.repository_owner == 'geotribu' }} | |
| # Deploy to the github-pages environment | |
| environment: | |
| name: github-pages | |
| url: ${{ steps.deployment.outputs.page_url }} | |
| steps: | |
| - name: Get source code | |
| uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 0 | |
| - name: Set up Python | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: 3.11 | |
| cache: "pip" | |
| - name: Install dependencies | |
| env: | |
| GH_TOKEN_MATERIAL_INSIDERS: ${{ secrets.GH_TOKEN_MATERIAL_INSIDERS }} | |
| run: | | |
| python -m pip install --upgrade pip setuptools wheel | |
| python -m pip install --upgrade -r requirements-insiders.txt | |
| - name: Cache build dependencies (external assets downloaded) | |
| uses: actions/cache@v4 | |
| with: | |
| key: ${{ github.ref }} | |
| path: .cache | |
| - name: Build static website | |
| run: | | |
| geotribu --help > content/toc_nav_ignored/snippets/code/geotribu_cli_help.txt | |
| python scripts/050_mkdocs_populate_latest.py -c mkdocs.yml | |
| python scripts/100_mkdocs_config_merger.py -c mkdocs.yml | |
| mkdocs build --clean --config-file mkdocs.yml --verbose --strict | |
| env: | |
| MKDOCS_ENABLE_PLUGIN_GIT_AUTHORS: true | |
| MKDOCS_ENABLE_PLUGIN_GIT_COMMITTERS: true | |
| MKDOCS_ENABLE_PLUGIN_GIT_DATES: true | |
| MKDOCS_ENABLE_PLUGIN_PRIVACY: true | |
| MKDOCS_ENABLE_PLUGIN_SOCIAL: true | |
| MKDOCS_ENABLE_PLUGIN_SOCIAL_CARDS: true | |
| MKDOCS_ENABLE_PLUGIN_RSS: true | |
| MKDOCS_ENABLE_PLUGIN_TAGS: true | |
| MKDOCS_ENABLE_PLUGIN_TYPESET: true | |
| MKDOCS_GIT_COMMITTERS_APIKEY: ${{ secrets.GITHUB_TOKEN }} | |
| MKDOCS_GOOGLE_ANALYTICS_KEY: ${{ secrets.GOOGLE_ANALYTICS_KEY }} | |
| - name: Setup Pages | |
| uses: actions/configure-pages@v5 | |
| - name: Upload artifact | |
| uses: actions/upload-pages-artifact@v3 | |
| with: | |
| # Upload entire repository | |
| path: "build/mkdocs/site" | |
| - name: Deploy to GitHub Pages | |
| id: deployment | |
| uses: actions/deploy-pages@v4 |