forked from stdlib-js/stdlib
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathpackage_commands_comment
More file actions
executable file
·253 lines (195 loc) · 6.61 KB
/
package_commands_comment
File metadata and controls
executable file
·253 lines (195 loc) · 6.61 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
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
#!/usr/bin/env bash
#
# @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.
# Script to post a comment with relevant `make` commands tailored to packages changed in a PR.
#
# Usage: package_commands_comment <pr_number>
#
# Arguments:
#
# pr_number Pull request number.
#
# Environment variables:
#
# GITHUB_TOKEN GitHub token for authentication.
# Ensure that the exit status of pipelines is non-zero in the event that at least one of the commands in a pipeline fails:
set -o pipefail
# VARIABLES #
# Resolve the pull request number:
pr_number="$1"
# GitHub API base URL:
github_api_url="https://api.github.com"
# Repository owner and name:
repo_owner="stdlib-js"
repo_name="stdlib"
# FUNCTIONS #
# Error handler.
#
# $1 - error status
on_error() {
echo 'ERROR: An error was encountered during execution.' >&2
exit "$1"
}
# Prints a success message.
print_success() {
echo 'Success!' >&2
}
# Performs a GitHub API request.
#
# $1 - HTTP method (GET or POST)
# $2 - API endpoint
# $3 - data for POST requests
github_api() {
local method="$1"
local endpoint="$2"
local data="$3"
# Initialize an array to hold curl headers:
local headers=()
# If GITHUB_TOKEN is set, add the Authorization header:
if [ -n "${GITHUB_TOKEN}" ]; then
headers+=("-H" "Authorization: token ${GITHUB_TOKEN}")
fi
# Determine the HTTP method and construct the curl command accordingly...
case "${method}" in
GET)
curl -s "${headers[@]}" "${github_api_url}${endpoint}"
;;
POST)
# For POST requests, always set the Content-Type header:
headers+=("-H" "Content-Type: application/json")
# If data is provided, include it in the request:
if [ -n "${data}" ]; then
curl -s -X POST "${headers[@]}" -d "${data}" "${github_api_url}${endpoint}"
else
# Handle cases where POST data is required but not provided:
echo "ERROR: POST request requires data."
on_error 1
fi
;;
*)
echo "ERROR: Invalid HTTP method: ${method}."
on_error 1
;;
esac
}
# Main execution sequence.
main() {
local directories
local packages
local response
local c_files
local comment
local files
if [ -z "${pr_number}" ]; then
echo "ERROR: Pull request number is required." >&2
on_error 1
fi
# Fetch changed files in pull request:
response=$(github_api "GET" "/repos/${repo_owner}/${repo_name}/pulls/${pr_number}/files?per_page=100")
files=$(echo "${response}" | jq -r '.[] | .filename')
# Extract files associated with native add-ons:
c_files=$(echo "${files}" | grep -e '/benchmark/c' -e '/examples/c' -e '/binding.gyp' -e '/include.gypi' -e '/src/')
# Find unique package directories:
directories=$(echo "${files}" | tr ' ' '\n' | \
xargs dirname | \
grep '^lib/node_modules/@stdlib' | \
sed -E 's/\/(benchmark|bin|data|docs|etc|examples|include|lib|scripts|src|test)(\/.*)?$//' | \
sort -u)
# Extract package names from changed package directories (e.g., @stdlib/math/base/special/sin) by removing the leading 'lib/node_modules/':
packages=$(echo "${directories}" | sed -E 's/^lib\/node_modules\///')
# Documentation links:
docs_links="
## Documentation Links
- [make rules for running examples][make-docs-examples]
- [make rules for running unit tests][make-docs-test]
- [make rules for running benchmarks][make-docs-benchmark]
[make-docs-examples]: https://github.com/stdlib-js/stdlib/blob/develop/tools/make/lib/examples/README.md
[make-docs-test]: https://github.com/stdlib-js/stdlib/blob/develop/tools/make/lib/test/README.md
[make-docs-benchmark]: https://github.com/stdlib-js/stdlib/blob/develop/tools/make/lib/benchmark/README.md"
# Count the number of packages:
package_count=$(echo "${packages}" | wc -l)
if [[ $package_count -gt 1 ]]; then
# Multiple packages case:
comment="Hello! 👋
Pro-tip: This PR changes multiple packages. You can use various \`make\` rules with \`*_FILTER\` environment variables to run tests, benchmarks, and examples for specific packages.
For each of the commands, please run them from the root stdlib repository directory (not the package folder!).
You can use pattern matching to target specific packages as follows:
\`\`\`bash
# Run tests for all packages in the math namespace:
make test TESTS_FILTER=\".*/@stdlib/math/.*\"
# Run benchmarks for specific packages (using OR pattern):
make benchmark BENCHMARKS_FILTER=\".*/@stdlib/math/base/special/(sin|cos)/.*\"
\`\`\`
## Changed Packages
$(echo "${packages}" | sed 's/^/- `/' | sed 's/$/`/')
${docs_links}"
else
# Single package case:
if [[ "${#c_files[@]}" -eq 0 ]]; then
comment="Hello! 👋
Pro-tip: Use the \`make\` commands below during local development to ensure that all tests, examples, and benchmark files in your PR run successfully.
For each of the commands, please run them from the root stdlib repository directory (not the package folder!).
To run unit tests,
\`\`\`bash
make test TESTS_FILTER=\".*/${packages}/.*\"
\`\`\`
To run benchmarks,
\`\`\`bash
make benchmark BENCHMARKS_FILTER=\".*/${packages}/.*\"
\`\`\`
To run examples,
\`\`\`bash
make examples EXAMPLES_FILTER=\".*/${packages}/.*\"
\`\`\`
${docs_links}"
else
comment="Hello! 👋
Pro-tip: Use the \`make\` below commands during local development to ensure that all tests, examples, and benchmark files in your PR run successfully.
For each of the commands, please run them from the root stdlib repository directory (not the package folder!).
To build a native add-on,
\`\`\`bash
NODE_ADDONS_PATTERN=\"${packages}\" make install-node-addons
\`\`\`
To run unit tests,
\`\`\`bash
make test TESTS_FILTER=\".*/${packages}/.*\"
\`\`\`
To run benchmarks,
\`\`\`bash
make benchmark BENCHMARKS_FILTER=\".*/${packages}/.*\"
\`\`\`
\`\`\`bash
make benchmark-c BENCHMARKS_FILTER=\".*/${packages}/.*\"
\`\`\`
To run examples,
\`\`\`bash
make examples EXAMPLES_FILTER=\".*/${packages}/.*\"
\`\`\`
\`\`\`bash
make examples-c EXAMPLES_FILTER=\".*/${packages}/.*\"
\`\`\`
${docs_links}"
fi
fi
if ! github_api "POST" "/repos/${repo_owner}/${repo_name}/issues/${pr_number}/comments" "{\"body\":$(echo "${comment}" | jq -R -s -c .)}"; then
echo "Failed to post comment on PR."
on_error 1
fi
print_success
exit 0
}
main