1
- uses: ./.github/actions/setup
2
  with:
3
    node-version: "20"

1
# 这里的名称会显示在对应 badge 上
2
name: Build
3

4
on:
5
  # 注意：新创建的仓库主分支已经变为 `main`，需要根据情况修改
6
  push:
7
    branches: [master]
8
  pull_request:
9
    branches: [master]
10
  # 通常用在使用 action 发包的场合
11
  tags:
12
    - "v*"
13
  # 定时触发器 注意时区是 UTC
14
  schedule:
15
    - cron: "0 0 * * *" # At every day 00:00(UTC).
16
  # 如果需要手动触发
17
  # 进阶用法参考 https://docs.github.com/en/free-pro-team@latest/actions/reference/events-that-trigger-workflows#example-workflow-configuration
18
  workflow_dispatch:
19

20
jobs:
21
  # 这里的 `build` 仅作为 job 名称，可以根据情况修改
22
  build:
23
    # 大部分情况下，不使用 strategy 也毫无问题
24
    strategy:
25
      matrix:
26
        node-version: [14.x]
27
        os: [ubuntu-latest]
28

29
    # 提供一个可以跳过 CI 的方式
30
    if: "!contains(github.event.head_commit.message, '[skip ci]')"
31
    runs-on: ${{ matrix.os }}
32

33
    steps:
34
      - name: ...
35
      - name: ...

1
# 注意：默认签出时只会签出一个提交
2
# 此时没有任何 tag，commit hash 也和线下不同
3
# 因此在需要完整 commit 或 tag 时需要使用 fetch-depth 参数
4
- uses: actions/checkout@v2
5
  # with:
6
  #   fetch-depth: 0
7

8
# 如果没有设置 `strategy.matrix` 需要替换一下
9
- name: Use Node.js ${{ matrix.node-version }}
10
  uses: actions/setup-node@v1
11
  with:
12
    node-version: ${{ matrix.node-version }}
13
    # 注意：在需要发布 npm 包时要明确指定 `registry-url`
14
    # registry-url: https://registry.npmjs.org

1
- uses: pnpm/action-setup@v2
2
  with:
3
    version: "latest"
4

5
- name: Use Node.js ${{ matrix.node-version }}
6
  uses: actions/setup-node@v2
7
  with:
8
    node-version: ${{ matrix.node-version }}
9
    cache: "pnpm"

1
- name: Install
2
  uses: bahmutov/npm-install@v1

1
# `reportUnusedDisableDirectives` 也可以配置在配置文件中
2
- name: Lint
3
  run: yarn lint --report-unused-disable-directives --max-warnings=0
4

5
- name: Type check
6
  run: yarn typeCheck # tsc --noEmit
7

8
# 如果对接了其他应用，还需要上传测试覆盖
9
- name: Test
10
  run: yarn test --coverage # jest --coverage
11

12
- name: Test E2E
13
  run: yarn test:e2e-ci
14

15
# 如果你的项目内部有相互依赖（如 monorepo），那么大概率需要在做其他检查之前 build
16
- name: Build
17
  run: yarn build
18

19
# 如果使用了 cypress
20
# 在失败时尝试上传视频/截图信息
21
- name: Upload artifacts
22
  if: ${{ failure() }}
23
  uses: actions/upload-artifact@v2
24
  with:
25
    name: cypress-artifacts
26
    path: |
27
      cypress/images
28
      cypress/videos
29
    if-no-files-found: ignore

1
jobs:
2
  build:
3
    runs-on: ubuntu-latest
4

5
    permissions:
6
      contents: read # to access the repository
7
      pages: write # to deploy to Pages
8
      id-token: write # to verify the deployment originates from an appropriate source
9

10
    steps:
11
      - name: Upload artifacts
12
        # https://github.com/actions/upload-pages-artifact
13
        uses: actions/upload-pages-artifact@v3
14
        with:
15
          path: "./packages/dist"
16

17
      - name: Deploy GitHub Pages
18
        if: github.ref == 'refs/heads/main'
19
        # https://github.com/actions/deploy-pages
20
        uses: actions/deploy-pages@v4

1
- name: Deploy GitHub Pages
2
  # 注意：如果你的 workflow 还带 PR 触发，没有这个限制会把其他人的 PR 部署上去，存在安全和爆炸风险
3
  if: github.ref == 'refs/heads/master'
4
  uses: peaceiris/actions-gh-pages@v3
5
  with:
6
    github_token: ${{ secrets.GITHUB_TOKEN }}
7
    publish_dir: dist/public
8
    # 只保留一个提交
9
    force_orphan: true