bluesky-httpserver/.github/workflows/docs_publish.yml at main · bluesky/bluesky-httpserver · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
name: Documentation

on:
  push:
    branches:
      - main

jobs:
  build:
    if: github.repository_owner == 'bluesky'

    name: Build and publish docs

    runs-on: ubuntu-latest

    env:
      python_env: py313

    strategy:
      fail-fast: false

    steps:
      - uses: actions/checkout@v4
        with:
          # Need this to get version number from last tag
          fetch-depth: 0

      - uses: shogo82148/actions-setup-redis@v1
        with:
          redis-version: "7.x"

      - uses: prefix-dev/setup-pixi@v0.10.0

      - name: Install dev dependencies
        run: |
          set -vxeuo pipefail
          pixi install --environment=${{ env.python_env }}
          pixi list --environment=${{ env.python_env }}
          pixi run --environment=${{ env.python_env }} pip list
          pixi run --environment=${{ env.python_env }} conda list

      - name: Run pre-commit
        run: |
          pixi run --environment=${{ env.python_env }} make -C docs/ html

      - name: Deploy documentation to blueskyproject.io
        # We pin to the SHA, not the tag, for security reasons.
        # https://docs.github.com/en/free-pro-team@latest/actions/learn-github-actions/security-hardening-for-github-actions#using-third-party-actions
        uses: peaceiris/actions-gh-pages@bbdfb200618d235585ad98e965f4aafc39b4c501  # v3.7.3
        with:
          deploy_key: ${{ secrets.ACTIONS_DOCUMENTATION_DEPLOY_KEY }}
          publish_branch: master
          publish_dir: ./docs/build/html
          external_repository: bluesky/bluesky.github.io
          destination_dir: bluesky-httpserver
          keep_files: true  # Keep old files.
          force_orphan: false  # Keep git history.