ozone-site/.github/workflows/static.yml at master · fmorg-git/ozone-site · 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
# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements.  See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership.  The ASF licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance
# with the License.  You may obtain a copy of the License at
#
#   http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied.  See the License for the
# specific language governing permissions and limitations
# under the License.

# Static analysis of website files.
# These jobs only require pnpm's dev dependencies and do not building or running the website.

name: static

on:
  workflow_call:

concurrency:
  group: static-${{ github.event.pull_request.number || github.sha }}
  cancel-in-progress: ${{ github.event_name == 'pull_request' }}

env:
  script_dir: .github/scripts
  resource_dir: .github/resource
  node_version: 20

jobs:
  license:
    runs-on: ubuntu-latest
    steps:
    - name: Checkout project
      uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
      with:
        persist-credentials: false
    - name: Check Apache license headers
      uses: apache/skywalking-eyes@61275cc80d0798a405cb070f7d3a8aaf7cf2c2c1 # v0.8.0
  file-names:
    runs-on: ubuntu-latest
    steps:
    - name: Checkout project
      uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
      with:
        persist-credentials: false
    - name: Run file name check
      working-directory: ${{ env.script_dir }}
      run: |
        ./file_names.sh
  spelling:
    runs-on: ubuntu-latest
    steps:
    - name: Checkout project
      uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
      with:
        persist-credentials: false
    - name: Enable corepack
      run: |
        npm i -g --force corepack # see https://github.com/actions/setup-node/issues/1222
        corepack enable
    - name: Use Node.js ${{ env.node_version }}
      uses: actions/setup-node@48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e # v6.4.0
      with:
        node-version: ${{ env.node_version }}
        cache: pnpm
    - name: Install pnpm dependencies
      run: pnpm install --dev
    - name: Run spelling check
      working-directory: ${{ env.script_dir }}
      run: |
        ./spelling.sh
    - name: Output spelling check tips
      if: ${{ failure() }}
      run: |
        cat $resource_dir/spelling_tips.md >> $GITHUB_STEP_SUMMARY
  lint:
    runs-on: ubuntu-latest
    steps:
    - name: Checkout project
      uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
      with:
        persist-credentials: false
    - name: Enable corepack
      run: |
        npm i -g --force corepack # see https://github.com/actions/setup-node/issues/1222
        corepack enable
    - name: Use Node.js ${{ env.node_version }}
      uses: actions/setup-node@48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e # v6.4.0
      with:
        node-version: ${{ env.node_version }}
        cache: pnpm
    - name: Install pnpm dependencies
      run: pnpm install --dev
    - name: Run lint
      run: pnpm run lint
  check-sidebar:
    runs-on: ubuntu-latest
    steps:
    - name: Checkout project
      uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
      with:
        persist-credentials: false
    - name: Enable corepack
      run: |
        npm i -g --force corepack # see https://github.com/actions/setup-node/issues/1222
        corepack enable
    - name: Use Node.js ${{ env.node_version }}
      uses: actions/setup-node@48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e # v6.4.0
      with:
        node-version: ${{ env.node_version }}
        cache: pnpm
    - name: Install pnpm dependencies
      run: pnpm install --dev
    - name: Run docs sidebar check
      working-directory: ${{ env.script_dir }}
      run: |
        ./sidebar.sh
    - name: Output sidebar check tips
      if: ${{ failure() }}
      run: |
        cat $resource_dir/sidebar_tips.md >> $GITHUB_STEP_SUMMARY