forked from stdlib-js/stdlib
-
Notifications
You must be signed in to change notification settings - Fork 0
200 lines (175 loc) · 6.99 KB
/
run_tests_coverage_pr.yml
File metadata and controls
200 lines (175 loc) · 6.99 KB
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
#/
# @license Apache-2.0
#
# Copyright (c) 2025 The Stdlib Authors.
#
# Licensed 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.
#/
# Workflow name:
name: run_tests_coverage_pr
# Workflow triggers:
on:
pull_request:
types:
- opened
- synchronize
- reopened
paths:
# List paths for which changes should trigger this workflow:
- 'lib/**/bin/**'
- 'lib/**/data/**'
- 'lib/**/etc/**'
- 'lib/**/include/**'
- 'lib/**/lib/**'
- 'lib/**/src/**'
- 'lib/**/test/**'
- 'lib/**/*.gyp'
- 'lib/**/*.gypi'
- 'lib/**/manifest.json'
- 'package.json'
# List paths for which changes should *not* trigger this workflow:
- '!lib/**/_tools/**'
# Global permissions:
permissions:
# Allow read-only access to the repository contents:
contents: read
# Workflow jobs:
jobs:
# Define a job for calculating test coverage for changed files...
coverage:
# Define a display name:
name: 'Calculate test coverage for PR packages'
# Only run this job if the pull request does not have a "ci: Skip" label:
if: "!contains(github.event.pull_request.labels.*.name, 'ci: Skip')"
# Define the type of virtual host machine:
runs-on: ubuntu-latest
# Define the sequence of job steps...
steps:
# Checkout the repository:
- name: 'Checkout repository'
# Pin action to full length commit SHA
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
with:
# Specify whether to remove untracked files before checking out the repository:
clean: true
# Limit clone depth to the last 1000 commits:
fetch-depth: 1000
# Specify whether to download Git-LFS files:
lfs: false
timeout-minutes: 10
# Install Node.js:
- name: 'Install Node.js'
# Pin action to full length commit SHA
uses: actions/setup-node@6044e13b5dc448c55e2357c09f80417699197238 # v6.2.0
with:
node-version: '20' # 'lts/*'
timeout-minutes: 5
# Cache dependencies:
- name: 'Cache dependencies'
# Pin action to full length commit SHA
uses: actions/cache@cdf6c1fa76f9f475f3d7449005a359c84ca0f306 # v5.0.3
id: cache
with:
path: |
${{ github.workspace }}/node_modules
key: ${{ runner.os }}-node-${{ hashFiles('**/package.json') }}
restore-keys: |
${{ runner.os }}-node-
# Install dependencies (accounting for possible network failures, etc, when installing node module dependencies):
- name: 'Install dependencies'
if: steps.cache.outputs.cache-hit != 'true'
run: |
make install-node-modules || make install-node-modules || make install-node-modules
timeout-minutes: 15
# Initialize development environment:
- name: 'Initialize development environment'
run: |
make init
timeout-minutes: 5
# Get list of changed directories:
- name: 'Get list of changed directories'
id: changed-directories
continue-on-error: true
run: |
# Get changed files using git diff against base branch:
git fetch origin ${{ github.base_ref }} --depth=1
files=$(git diff --diff-filter=AM --name-only origin/${{ github.base_ref }}...HEAD)
directories=$(for file in $files; do dirname $file; done | uniq | tr '\n' ' ' | sed 's/ $//')
echo "directories=${directories}" >> $GITHUB_OUTPUT
# Exit early if non-package directories are changed:
- name: 'Exit early if non-package directories are changed'
id: check-changed
run: |
directories="${{ steps.changed-directories.outputs.directories }}"
skip="false"
for directory in $directories; do
if [[ "$directory" != "lib/node_modules/@stdlib"* ]]; then
echo "Warning: changed directory '$directory' is not in 'lib/node_modules/@stdlib'. Skipping the rest of the workflow."
skip="true"
break
fi
done
echo "skip=${skip}" >> $GITHUB_OUTPUT
# Run JavaScript tests:
- name: 'Run JavaScript tests'
id: extract-coverage
if: steps.check-changed.outputs.skip == 'false'
env:
GITHUB_REPO: ${{ github.repository }}
GITHUB_REF: ${{ github.ref }}
COVERAGE_BASE_URL: 'https://coverage.stdlib.io/pr-${{ github.event.pull_request.number }}'
run: |
directories="${{ steps.changed-directories.outputs.directories }}"
. "$GITHUB_WORKSPACE/.github/workflows/scripts/run_tests_coverage/run" "$directories"
timeout-minutes: 30
# Create final coverage report:
- name: 'Create final coverage report'
id: create-report
if: steps.check-changed.outputs.skip == 'false'
run: |
table="${{ steps.extract-coverage.outputs.table }}"
if [ -z "$table" ]; then
report="## Coverage Report\n\nNo coverage information available."
else
compare_url="https://github.com/stdlib-js/stdlib/compare/${{ github.event.pull_request.base.sha }}...${{ github.event.pull_request.head.sha }}"
compare_txt="The above coverage report was generated for the [changes in this PR]($compare_url)."
report="## Coverage Report\n\n${table}\n\n${compare_txt}"
fi
echo "report=$report" >> $GITHUB_OUTPUT
# Save PR metadata for the publish workflow:
- name: 'Save PR metadata'
if: steps.check-changed.outputs.skip == 'false'
run: |
mkdir -p pr-metadata
echo "${{ github.event.pull_request.number }}" > pr-metadata/pr_number
cat > pr-metadata/report <<'EOF'
${{ steps.create-report.outputs.report }}
EOF
# Upload PR metadata as artifact:
- name: 'Upload PR metadata'
if: steps.check-changed.outputs.skip == 'false'
# Pin action to full length commit SHA
uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f # v6.0.0
with:
name: pr-metadata
path: pr-metadata/
retention-days: 1
# Upload coverage artifacts:
- name: 'Upload coverage artifacts'
if: steps.check-changed.outputs.skip == 'false'
# Pin action to full length commit SHA
uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f # v6.0.0
with:
name: coverage-artifacts
path: artifacts/
retention-days: 1