Remap all bindings (#930) #56
This file contains hidden or 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
| # Generates and deploys static site to GitHub Pages | |
| # https://docs.github.com/en/pages/getting-started-with-github-pages/using-custom-workflows-with-github-pages | |
| # Reference workflow: https://github.com/actions/starter-workflows/blob/main/pages/jekyll-gh-pages.yml | |
| name: Metro Docs Site | |
| on: | |
| push: | |
| branches: ["main"] | |
| # Allows manual deployements (if needed) | |
| 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: | |
| # Metro docs site build job | |
| docs-site: | |
| runs-on: ubuntu-latest | |
| if: github.repository == 'zacsweers/metro' | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5 | |
| - name: Configure JDK | |
| uses: actions/setup-java@v4 | |
| with: | |
| distribution: 'zulu' | |
| java-version-file: .github/workflows/.java-version | |
| - name: Setup Gradle | |
| uses: gradle/actions/setup-gradle@v4 | |
| with: | |
| # Only save Gradle User Home state for builds on the 'main' branch. | |
| # Builds on other branches will only read existing entries from the cache. | |
| cache-read-only: ${{ github.ref != 'refs/heads/main' }} | |
| # Don't reuse cache entries from any other Job. | |
| gradle-home-cache-strict-match: true | |
| cache-encryption-key: ${{ secrets.GRADLE_ENCRYPTION_KEY }} | |
| - name: Generate API docs | |
| # NOTE: The `dokkaPublications.html` task is pre-configured to generate HTML in `/docs/api`. | |
| run: ./scripts/generate_docs_dokka.sh | |
| env: | |
| GRADLE_OPTS: -Xmx4g # Dokka can be memory intensive, so we increase the heap size | |
| - name: Set up Python | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: '3.13' | |
| - name: Install MkDocs dependencies | |
| run: | | |
| pip install --requirement .github/workflows/mkdocs-requirements.txt | |
| - name: Copy documentation files | |
| run: ./scripts/copy_docs_files.sh | |
| - name: Setup Pages | |
| uses: actions/configure-pages@v5 | |
| - name: Build MkDocs site | |
| run: mkdocs build | |
| - name: Upload artifact | |
| uses: actions/upload-pages-artifact@v3 | |
| with: | |
| path: './site' | |
| # Deployment job | |
| deploy: | |
| environment: | |
| name: github-pages | |
| url: ${{ steps.deployment.outputs.page_url }} | |
| runs-on: ubuntu-latest | |
| needs: docs-site | |
| steps: | |
| - name: Deploy to GitHub Pages | |
| id: deployment | |
| uses: actions/deploy-pages@v4 |