pixi/.github/workflows/docs.yml at ad504aad803db47f62108fe745c0c295b08489b7 · prefix-dev/pixi · 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
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
name: Deploy Docs

on:
  push:
    branches:
      - main
      - update-pixi
    paths:
      - "docs/**"
      - ".github/workflows/docs.yml"
      - "mkdocs.yml"
      - "pixi.*"
      - "install/*"
    tags:
      - v**
  pull_request:
    branches:
      - main
    paths:
      - "docs/**"
      - ".github/workflows/docs.yml"
      - "mkdocs.yml"
      - "pixi.*"
      - "install/*"
  workflow_dispatch:
    inputs:
      tag:
        description: "Tag to deploy"
        required: true
        default: "v0.0.0"

# Allow one concurrent deployment
concurrency:
  group: "pages"
  cancel-in-progress: true

permissions:
  contents: read

jobs:
  build-docs:
    if: github.ref != 'refs/heads/main' && !startsWith(github.ref, 'refs/tags/v')
    runs-on: ubuntu-latest
    steps:
      - name: Checkout repository
        uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6
        with:
          submodules: recursive
          persist-credentials: false

      - uses: prefix-dev/setup-pixi@82d477f15f3a381dbcc8adc1206ce643fe110fb7 # v0.9.3
        with:
          environments: docs
          cache-write: ${{ github.ref == 'refs/heads/main' }}

      - name: Build docs for test
        run: |
          pixi run build-docs

  docs-release:
    # Don't run on forks
    if: github.repository == 'prefix-dev/pixi' && (startsWith(github.event.ref, 'refs/tags/v') || github.event_name == 'workflow_dispatch' && startsWith(github.event.inputs.tag, 'v'))
    runs-on: ubuntu-latest
    permissions:
      contents: write
    steps:
      - name: Checkout repository
        uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6
        with:
          # fetch everything so we can checkout the tag
          fetch-depth: 0
          submodules: recursive

      # check out tag if workflow_dispatch
      - name: Checkout tag
        if: github.event_name == 'workflow_dispatch'
        run: |
          git checkout tags/${GITHUB_EVENT_INPUTS_TAG}
        env:
          GITHUB_EVENT_INPUTS_TAG: ${{ github.event.inputs.tag }}

      - uses: prefix-dev/setup-pixi@82d477f15f3a381dbcc8adc1206ce643fe110fb7 # v0.9.3
        with:
          environments: docs
          cache-write: ${{ github.ref == 'refs/heads/main' }}

      - name: Configure Git user
        run: |
          git config --local user.email "github-actions[bot]@users.noreply.github.com"
          git config --local user.name "github-actions[bot]"

      - name: Extract tag name
        if: github.event_name != 'workflow_dispatch'
        run: echo "RELEASE_VERSION=${GITHUB_REF#refs/*/}" >> $GITHUB_ENV

      - name: Tag from workflow_dispatch
        if: github.event_name == 'workflow_dispatch'
        run: echo "RELEASE_VERSION=${GITHUB_EVENT_INPUTS_TAG}" >> $GITHUB_ENV
        env:
          GITHUB_EVENT_INPUTS_TAG: ${{ github.event.inputs.tag }}

      - name: Deploy with mike 🚀
        run: |
          pixi run -e docs mike deploy --push --update-aliases $RELEASE_VERSION latest

  docs-dev:
    # Don't run on forks
    if: github.repository == 'prefix-dev/pixi' && (github.ref == 'refs/heads/main' || github.event_name == 'workflow_dispatch' && !startsWith(github.event.inputs.tag, 'v'))
    runs-on: ubuntu-latest
    permissions:
      contents: write
    steps:
      - name: Checkout repository
        uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6
        with:
          # fetch everything so we can checkout the tag
          fetch-depth: 0
          submodules: recursive

      - uses: prefix-dev/setup-pixi@82d477f15f3a381dbcc8adc1206ce643fe110fb7 # v0.9.3
        with:
          environments: docs
          cache-write: ${{ github.ref == 'refs/heads/main' }}

      - name: Configure Git user
        run: |
          git config --local user.email "github-actions[bot]@users.noreply.github.com"
          git config --local user.name "github-actions[bot]"

      - name: Deploy with mike 🚀
        run: |
          pixi run deploy-dev

      - name: Copy file to gh-pages
        run: |
          git fetch
          git checkout gh-pages
          git checkout main -- install/install.sh install/install.ps1
          mv install/install.sh install/install.ps1 .
          git restore --staged .
          git add install.sh install.ps1
          # Check diff before committing
          git diff-index --quiet HEAD || git commit -m "Update install scripts from main"
          git push origin gh-pages

      - name: Checkout main branch
        # Important to run the post setup-pixi steps, we want to cache based on the `main` branch and we checked out another in the step above.
        run: git checkout main