chore: update config 10 #73
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: Build and deploy docs | |
| on: | |
| push: | |
| branches: | |
| - main | |
| tags: | |
| - "*.*.*" | |
| pull_request: | |
| branches: | |
| - main | |
| workflow_dispatch: | |
| permissions: | |
| contents: read | |
| jobs: | |
| build: | |
| if: github.repository_owner == 'xonsh' | |
| runs-on: ubuntu-latest | |
| env: | |
| UV_CACHE_DIR: .cache/uv | |
| name: Xonsh docs to gh-pages | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Setup Python | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: "3.10" | |
| - uses: yezz123/setup-uv@v4 | |
| - name: set current week | |
| run: echo WEEK=$(date +%V) >>$GITHUB_ENV | |
| shell: bash | |
| - name: Cache uv pip for a week | |
| id: cache-uv | |
| uses: actions/cache@v4 | |
| with: | |
| path: ${{ env.UV_CACHE_DIR }} | |
| key: ${{ runner.os }}-uv-${{ hashFiles('pyproject.toml') }}-${{ env.WEEK }} | |
| restore-keys: ${{ runner.os }}-uv- | |
| - run: uv pip install --system -e '.[doc]' | |
| - name: Build Docs | |
| run: cd docs && make html | |
| - uses: tibdex/github-app-token@v2 | |
| if: ${{ github.event_name != 'pull_request' }} | |
| id: generate-token | |
| with: | |
| app_id: ${{ secrets.APP_ID }} | |
| private_key: ${{ secrets.APP_PRIVATE_KEY }} | |
| repository: xonsh/xonsh-docs | |
| - name: Deploy to dev if not tagged | |
| if: github.event_name != 'pull_request' && !startsWith(github.ref, 'refs/tags/v') | |
| uses: peaceiris/actions-gh-pages@v4 | |
| with: | |
| personal_token: ${{ steps.generate-token.outputs.token }} | |
| external_repository: xonsh/xonsh-docs | |
| publish_dir: ./docs/_build/html | |
| destination_dir: dev # latest as in main branch | |
| - name: Deploy to stable if tagged | |
| if: github.event_name != 'pull_request' && startsWith(github.ref, 'refs/tags/v') | |
| uses: peaceiris/actions-gh-pages@v4 | |
| with: | |
| personal_token: ${{ steps.generate-token.outputs.token }} | |
| external_repository: xonsh/xonsh-docs | |
| publish_dir: ./docs/_build/html | |
| # # todo: implement versioned docs | |