milkdown/.github/workflows/ci.yml at 9ca05e85d105830891b9e88a9addadfd2770e2e9 · Milkdown/milkdown · 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
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
name: ci

on:
  merge_group:
  push:
    branches: [main]
  pull_request:
    branches: [main]

concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true

jobs:
  install-deps:
    runs-on: ubuntu-latest

    steps:
      - name: Checkout code repository
        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
        with:
          fetch-depth: 0

      - uses: ./.github/actions/setup

  lint:
    runs-on: ubuntu-latest
    needs: install-deps
    steps:
      - name: Checkout code repository
        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
        with:
          fetch-depth: 0

      - uses: ./.github/actions/setup

      - name: Run lint
        run: pnpm test:lint --format github

  unit:
    runs-on: ubuntu-latest
    needs: install-deps
    steps:
      - name: Checkout code repository
        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
        with:
          fetch-depth: 0

      - uses: ./.github/actions/setup

      - name: Run unit tests
        run: pnpm test:unit

  build:
    runs-on: ubuntu-latest
    needs: install-deps
    steps:
      - name: Checkout code repository
        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
        with:
          fetch-depth: 0

      - uses: ./.github/actions/setup

      - name: Build packages
        run: pnpm build

      - name: Build API docs
        run: pnpm --filter=@milkdown/docs run build

      - name: Publish snapshot
        if: ${{ github.event_name == 'pull_request' }}
        run: >
          ./node_modules/.bin/pkg-pr-new publish --pnpm
          ./packages/plugins/*
          ./packages/integrations/*
          ./packages/core
          ./packages/ctx
          ./packages/exception
          ./packages/components
          ./packages/transformer
          ./packages/prose
          ./packages/utils
          ./packages/kit
          ./packages/crepe

  cache-browsers:
    # Download Playwright browser binaries once and populate the cache before the
    # e2e shards start, so the shards restore instead of each downloading in parallel.
    runs-on: ubuntu-latest
    needs: install-deps
    steps:
      - name: Checkout code repository
        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
        with:
          fetch-depth: 0

      - uses: ./.github/actions/setup

      - name: Cache Playwright browsers
        id: playwright-cache
        uses: actions/cache@55cc8345863c7cc4c66a329aec7e433d2d1c52a9 # v6.1.0
        with:
          path: ~/.cache/ms-playwright
          key: ${{ runner.os }}-playwright-${{ hashFiles('pnpm-lock.yaml') }}

      # Binaries only; system libraries are per-runner and re-installed in each shard.
      - name: Download browsers
        if: steps.playwright-cache.outputs.cache-hit != 'true'
        run: pnpm --filter=@milkdown/e2e exec playwright install

  e2e:
    runs-on: ubuntu-latest
    needs: cache-browsers
    strategy:
      fail-fast: false
      matrix:
        shard: [1, 2, 3, 4, 5]
    steps:
      - name: Checkout code repository
        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
        with:
          fetch-depth: 0

      - uses: ./.github/actions/setup

      - name: Build e2e
        run: |
          pnpm --filter=@milkdown/prose run build
          pnpm --filter=@milkdown/e2e run build

      - name: Cache Playwright browsers
        id: playwright-cache
        uses: actions/cache@55cc8345863c7cc4c66a329aec7e433d2d1c52a9 # v6.1.0
        with:
          path: ~/.cache/ms-playwright
          key: ${{ runner.os }}-playwright-${{ hashFiles('pnpm-lock.yaml') }}

      - name: Install browsers and system dependencies
        if: steps.playwright-cache.outputs.cache-hit != 'true'
        run: pnpm --filter=@milkdown/e2e test:install

      - name: Install browser system dependencies
        if: steps.playwright-cache.outputs.cache-hit == 'true'
        run: pnpm --filter=@milkdown/e2e exec playwright install-deps

      - name: Run playwright
        run: pnpm test:e2e --forbid-only --shard=${{ matrix.shard }}/${{ strategy.job-total }}

      - name: Upload blob report
        if: ${{ !cancelled() }}
        uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
        with:
          name: blob-report-${{ matrix.shard }}
          path: e2e/blob-report/
          retention-days: 7

      - name: Upload test results
        if: ${{ failure() }}
        uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
        with:
          name: test-results-e2e-${{ matrix.shard }}
          path: e2e/test-results/
          retention-days: 7

  merge-reports:
    # Merge shard blob reports into one HTML report. Runs even if some shards failed,
    # but not on cancellation. Report-only: does not gate the `summary` status.
    if: ${{ !cancelled() }}
    needs: e2e
    runs-on: ubuntu-latest
    steps:
      - name: Checkout code repository
        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
        with:
          fetch-depth: 0

      - uses: ./.github/actions/setup

      - name: Download blob reports
        uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1
        with:
          path: e2e/all-blob-reports
          pattern: blob-report-*
          merge-multiple: true

      - name: Merge blob reports into HTML report
        run: pnpm --filter=@milkdown/e2e exec playwright merge-reports --reporter html ./all-blob-reports

      - name: Upload HTML report
        uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
        with:
          name: playwright-html-report
          path: e2e/playwright-report/
          retention-days: 14

  summary:
    if: ${{ always() }}
    needs: [install-deps, cache-browsers, lint, unit, e2e, build]
    runs-on: ubuntu-latest
    steps:
      - name: On error
        if: ${{ always() && (contains(needs.*.result, 'failure') || contains(needs.*.result, 'cancelled')) }}
        run: exit 1