Move to mkdocs #51
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: MkDocs | |
| on: | |
| push: | |
| branches: | |
| - main | |
| pull_request: | |
| concurrency: | |
| group: ${{ github.workflow }}-${{ github.ref }} | |
| cancel-in-progress: true | |
| permissions: | |
| contents: write | |
| pull-requests: write | |
| jobs: | |
| deploy-docs: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Generate token | |
| id: app-token | |
| uses: actions/create-github-app-token@v1 | |
| with: | |
| app-id: ${{ secrets.APP_ID }} | |
| private-key: ${{ secrets.PRIVATE_KEY }} | |
| - name: Checkout repository | |
| uses: actions/checkout@v4 | |
| with: | |
| token: "${{ steps.app-token.outputs.token }}" | |
| # Fetch the entire git history (all branches + tags) | |
| # We do this because the docs use git describe, which requires having all | |
| # the commits up to the latest version tag. | |
| # We also need the gh-pages branch to push the docs to. | |
| fetch-depth: 0 | |
| # Make the github application be the committer | |
| # (see: https://stackoverflow.com/a/74071223 on how to obtain the committer email) | |
| - name: Setup git config | |
| run: | | |
| git config --global user.name "py-mine-ci-bot" | |
| git config --global user.email "121461646+py-mine-ci-bot[bot]@users.noreply.github.com" | |
| - name: Setup poetry | |
| id: poetry_setup | |
| uses: ItsDrike/setup-poetry@v1 | |
| with: | |
| python-version: 3.12 | |
| install-args: "--only main,docs" | |
| - name: Build the documentation (mkdocs - PR preview) | |
| if: ${{ github.event_name == 'pull_request' }} | |
| run: poetry run mkdocs build | |
| - name: Deploy docs - PR preview | |
| if: ${{ github.event_name == 'pull_request' }} | |
| uses: rossjrw/pr-preview-action@v1 | |
| with: | |
| source-dir: ./site | |
| preview-branch: gh-pages | |
| umbrella-dir: pr-preview | |
| token: ${{ steps.app-token.outputs.token }} | |
| - name: Build the documentation (mike) | |
| if: ${{ github.event_name == 'push' }} | |
| run: poetry run mike deploy latest | |
| - name: Deploy docs - latest | |
| if: ${{ github.event_name == 'push' }} | |
| run: git push origin gh-pages |