node-util/.github/workflows/test.yml at main · foxkit-js/node-util · 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
name: Test

on:
  ## This workflow runs on every push to main (including merges)
  push:
    branches: [main]
  ## This workflow also runs for every opened PR or push to PR branch
  pull_request:

jobs:
  ## First job that runs is linting. This ensures the syntax is valid in the
  ## first place. Feel free to reduce to `pnpm lint` if your ruleset is set up
  ## to where warnings are only stylistic preferences and not vital to ensure
  ## code validity.
  lint:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v4
      - name: Install pnpm v9
        uses: pnpm/action-setup@v4
        with:
          version: 9
      - name: Install Node.js v20
        uses: actions/setup-node@v4
        with:
          node-version: 20
          cache: pnpm
      - name: Install dependencies
        run: pnpm install --frozen-lockfile --ignore-scripts
      - name: Lint
        run: pnpm lint:strict

  ## This job runs after lint and runs prettier in check mode.
  ## Feel free to remove this if you're not strict with codestyle
  format:
    needs: lint
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v4
      - name: Install pnpm v9
        uses: pnpm/action-setup@v4
        with:
          version: 9
      - name: Install Node.js v20
        uses: actions/setup-node@v4
        with:
          node-version: 20
          cache: pnpm
      - name: Install dependencies
        run: pnpm install --frozen-lockfile --ignore-scripts
      - name: Check Formatting
        run: pnpm format:check

  ## This job runs after lint and runs TypeScript typechecks
  types:
    needs: lint
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v4
      - name: Install pnpm v9
        uses: pnpm/action-setup@v4
        with:
          version: 9
      - name: Install Node.js v20
        uses: actions/setup-node@v4
        with:
          node-version: 20
          cache: pnpm
      - name: Install dependencies
        run: pnpm install --frozen-lockfile --ignore-scripts
      - name: Typecheck
        run: pnpm typecheck

  ## Example for testing with matrix strategy to test current node versions
  ## (previous LTS, LTS and Current)
#  test:
#    needs: types
#    runs-on: ubuntu-latest
#    strategy:
#      matrix:
#        node-version: [18.x, 20.x, 22.x]
#    steps:
#      - name: Checkout
#        uses: actions/checkout@v4
#      - name: Install pnpm v9
#        uses: pnpm/action-setup@v4
#        with:
#          version: 9
#      - name: Use Node.js ${{ matrix.node-version }}
#        uses: actions/setup-node@v4
#        with:
#          node-version: ${{ matrix.node-version }}
#          cache: pnpm
#      - name: Install dependencies
#        run: pnpm install --frozen-lockfile --ignore-scripts
#      - name: Run Tests
#        run: pnpm test