nixvim/.github/workflows/website.yml at main · literally-sai/nixvim · 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
149
150
151
152
153
154
155
156
157
158
159
name: Documentation

on:
  push:
    branches:
      - main
  # Allow running manually
  workflow_dispatch:

# Allow one concurrent deployment
concurrency:
  group: docs-website
  cancel-in-progress: true

defaults:
  run:
    shell: bash

jobs:
  prepare:
    name: Version info
    runs-on: ubuntu-24.04-arm

    outputs:
      matrix: ${{ steps.matrix.outputs.result }}
      versions: ${{ steps.versions.outputs.result }}

    steps:
      - name: Checkout version-info
        uses: actions/checkout@v5
        with:
          sparse-checkout: version-info.toml
          sparse-checkout-cone-mode: false

      - name: Produce build matrix
        id: matrix
        uses: mikefarah/yq@master
        with:
          cmd: |
            yq --no-colors --output-format=json '
              [
                .versions
                | to_entries
                | reverse
                | .[]
                | {
                    "ref": .value.branch,
                    "name": .key,
                    "base-href": "/nixvim/"
                  }
                | select(.ref != "main").sub-path = .name
                | select(.ref != "main").base-href = "\(.base-href)\(.name)/"
              ]
            ' version-info.toml

      - name: Produce "other versions" array
        id: versions
        uses: mikefarah/yq@master
        with:
          cmd: |
            yq --no-colors --output-format=json '
              [
                .versions
                | to_entries
                | reverse
                | .[]
                | {
                    "branch": .value.branch,
                    "nixpkgsBranch": .value.channel,
                    "baseHref": "/nixvim/\(.key)/",
                    "status": .value.status
                  }
                | select(.branch == "main").baseHref = "/nixvim/"
              ]
            ' version-info.toml

  build:
    name: Build ${{ matrix.name }}
    runs-on: ubuntu-latest
    needs: prepare

    strategy:
      fail-fast: true
      matrix:
        include: ${{ fromJSON(needs.prepare.outputs.matrix) }}

    steps:
      - name: Install nix
        uses: cachix/install-nix-action@v31

      - name: Configure cachix
        uses: cachix/cachix-action@v16
        with:
          name: nix-community
          authToken: ${{ secrets.CACHIX_AUTH_TOKEN }}

      - name: Checkout
        uses: actions/checkout@v5
        with:
          ref: ${{ matrix.ref }}

        # Uses the build-docs action from the checked-out nixvim branch
      - name: Build docs
        uses: ./.github/actions/build-docs
        with:
          artifact-name: ${{ matrix.name }}-docs
          sub-path: ${{ matrix.sub-path }}
          base-href: ${{ matrix.base-href }}
          versions: ${{ needs.prepare.outputs.versions }}

  combine:
    name: Combine builds
    runs-on: ubuntu-24.04-arm
    needs: build

    env:
      in: artifacts
      out: combined

    steps:
      - name: Download artifacts
        uses: actions/download-artifact@v7
        with:
          path: ${{ env.in }}
          pattern: "*-docs"
          merge-multiple: false

      - name: Extract archives
        run: |
          mkdir -p "$out"
          find "$in" -name artifact.tar \
          | parallel tar \
              --verbose \
              --extract \
              --file {} \
              --directory "$out"

      - name: Upload artifact
        uses: actions/upload-pages-artifact@v4
        with:
          path: ${{ env.out }}

  deploy:
    name: Deploy
    runs-on: ubuntu-24.04-arm
    needs: combine

    permissions:
      pages: write # to deploy to Pages
      id-token: write # to verify the deployment originates from an appropriate source

    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}

    steps:
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v4