Bridge to OpenTelemetry without taking over its configuration #33
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
| name: Publish documentation | |
| on: | |
| push: | |
| branches: [master] | |
| paths: | |
| - "docs/**" | |
| - "mkdocs.yml" | |
| - ".github/workflows/docs.yml" | |
| workflow_dispatch: | |
| permissions: | |
| contents: read | |
| pages: write | |
| id-token: write | |
| concurrency: | |
| group: pages | |
| cancel-in-progress: false | |
| jobs: | |
| build: | |
| name: Build the site | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v7 | |
| - uses: actions/setup-python@v7 | |
| with: | |
| python-version: "3.12" | |
| cache: pip | |
| - run: pip install mkdocs-material mkdocs-static-i18n | |
| # Always built, even while the site cannot be published: --strict is what | |
| # catches a broken link or a missing translation, and that check is worth | |
| # having on every push regardless of where the output goes. | |
| - run: mkdocs build --strict | |
| # Pages needs enabling on the repository, which a private repository | |
| # cannot do without a paid plan. Skipped rather than left failing; it | |
| # begins publishing on its own once the repository is public. | |
| - uses: actions/configure-pages@v6 | |
| if: github.event.repository.visibility == 'public' | |
| - uses: actions/upload-pages-artifact@v5 | |
| if: github.event.repository.visibility == 'public' | |
| with: | |
| path: site | |
| deploy: | |
| name: Deploy to Pages | |
| needs: build | |
| if: github.event.repository.visibility == 'public' | |
| runs-on: ubuntu-latest | |
| environment: | |
| name: github-pages | |
| url: ${{ steps.deployment.outputs.page_url }} | |
| steps: | |
| - id: deployment | |
| uses: actions/deploy-pages@v5 |