docs/insiders #1606
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: π§ͺ Docs Test WorkFlow π | |
on: | |
pull_request: | |
branches: [main, develop] | |
# Restrict permissions by default | |
permissions: | |
contents: read # Required for checkout | |
checks: write # Required for test reporting | |
jobs: | |
docs-build-test: | |
name: Test docs build | |
runs-on: ubuntu-latest | |
timeout-minutes: 10 | |
strategy: | |
matrix: | |
python-version: ["3.10"] | |
steps: | |
- name: π₯ Checkout the repository | |
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 | |
with: | |
fetch-depth: 0 | |
- name: π Set up Python ${{ matrix.python-version }} | |
uses: actions/setup-python@0b93645e9fea7318ecaed2b359559ac225c90a2b # v5.3.0 | |
with: | |
python-version: ${{ matrix.python-version }} | |
- name: π Setup Poetry | |
uses: abatilo/actions-poetry@3765cf608f2d4a72178a9fc5b918668e542b89b1 # v4.0.0 | |
- name: π Create GitHub App token (mkdocs) | |
id: mkdocs_token | |
uses: actions/create-github-app-token@c1a285145b9d317df6ced56c09f525b5c2b6f755 # v1.11.1 | |
with: | |
app-id: ${{ secrets.MKDOCS_APP_ID }} | |
private-key: ${{ secrets.MKDOCS_PEM }} | |
owner: roboflow | |
repositories: mkdocs-material-insiders | |
- name: ποΈ Install dependencies | |
run: | | |
poetry config http-basic.github.com roboflow ${steps.mkdocs_token.outputs.token} | |
poetry install --with=docs | |
- name: π§ͺ Test Docs Build | |
run: | | |
poetry run mkdocs build --verbose |