forked from stdlib-js/stdlib
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathdeprecate_packages
More file actions
279 lines (227 loc) · 6.77 KB
/
deprecate_packages
File metadata and controls
279 lines (227 loc) · 6.77 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
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
#!/usr/bin/env bash
#
# @license Apache-2.0
#
# Copyright (c) 2022 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 deprecate packages on npm and GitHub.
#
# Usage: deprecate_packages pkg1 [pkg2 pkg3 ...]
#
# Arguments:
#
# pkg1 Package name.
# pkg2 Package name.
# pkg3 Package name.
#
#
# Environment variables:
#
# NPM_TOKEN Authentication token.
# GITHUB_TOKEN Authentication token.
# GITHUB_USER GitHub username.
# MSG Deprecation message.
# LOG_FILE Log file.
#
# shellcheck disable=SC2181,SC2153,SC2129
# 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 #
# Get the list of packages to deprecate:
pkgs="$*"
# Get the deprecation message (convert `@stdlib` package names in deprecation messages into hyperlinks):
deprecation_message="${MSG:-'Package no longer supported.'}"
# shellcheck disable=SC2016
deprecation_message=$(echo "${deprecation_message}" | sed -e 's/`\?@stdlib\/\([^ `]*\)`\?/[@stdlib\/\1](https:\/\/github.com\/stdlib-js\/\1)/g')
# Get the npm authentication token:
npm_token="${NPM_TOKEN}"
# Get the GitHub authentication token:
github_token="${GITHUB_TOKEN}"
# Get the GitHub username:
github_user="${GITHUB_USER}"
# Get the path to a log file as the third argument to the build script:
log_file="${LOG_FILE}"
# Define a heartbeat interval to periodically print messages in order to prevent CI from prematurely ending a build due to long running commands:
heartbeat_interval='30s'
# Declare a variable for storing the heartbeat process id:
heartbeat_pid=""
# FUNCTIONS #
# Error handler.
#
# $1 - error status
on_error() {
echo 'ERROR: An error was encountered during execution.' >&2
cleanup
exit "$1"
}
# Runs clean-up tasks.
cleanup() {
stop_heartbeat
}
# Starts a heartbeat.
#
# $1 - heartbeat interval
start_heartbeat() {
echo 'Starting heartbeat...' >&2
# Create a heartbeat and send to background:
heartbeat "$1" &
# Capture the heartbeat pid:
heartbeat_pid=$!
echo "Heartbeat pid: ${heartbeat_pid}" >&2
}
# Runs an infinite print loop.
#
# $1 - heartbeat interval
heartbeat() {
while true; do
echo "$(date) - heartbeat..." >&2;
sleep "$1";
done
}
# Stops the heartbeat print loop.
stop_heartbeat() {
echo 'Stopping heartbeat...' >&2
kill "${heartbeat_pid}"
}
# Prints a success message.
print_success() {
echo 'Success!' >&2
}
# Configures npm.
#
# $1 - npm authentication token
# $2 - log file
configure_npm() {
echo 'Configuring npm...' >> "$2" 2>&1
# Create a configuration file to allow authenticating with npm:
echo "//registry.npmjs.org/:_authToken=$1" > .npmrc
echo 'Successfully configured npm.' >> "$2" 2>&1
return 0
}
# Configures Git.
#
# $1 - log file
configure_git() {
echo 'Configuring Git...' >> "$1" 2>&1
git config --local user.email "noreply@stdlib.io"
git config --local user.name "stdlib-bot"
echo 'Successfully configured Git.' >> "$1" 2>&1
return 0
}
# Normalizes a package name.
#
# $1 - package name
normalize_package_name() {
local pkg
# Remove leading `@stdlib/` and convert to a standalone packge name:
pkg=$(echo "$1" | sed 's/^@stdlib\///' | sed -e 's/\//-/g')
echo "${pkg}"
}
# Deprecates a package on npm.
#
# $1 - package name
# $2 - deprecation message
# $3 - log file
npm_deprecate() {
echo "Deprecating package: $1..." >> "$3" 2>&1
npm deprecate "$1" "$2" >> "$3" 2>&1
if [[ "$?" -ne 0 ]]; then
echo "Encountered an error when deprecating package." >> "$3" 2>&1
return 1
fi
echo "Successfully deprecated package." >> "$3" 2>&1
return 0
}
# Deprecates a package on GitHub.
#
# $1 - repo slug
# $2 - deprecation message
# $3 - GitHub username
# $4 - GitHub authentication token
# $5 - log file
github_deprecate() {
echo "Deprecating repository: $1..." >> "$5" 2>&1
echo "Cloning repository..." >> "$5" 2>&1
git clone "https://github.com/$1" "deprecate_repo_dir" >> "$5" 2>&1
if [[ "$?" -ne 0 ]]; then
echo "Encountered an error when cloning repository." >> "$5" 2>&1
return 1
fi
echo "Successfully cloned repository." >> "$5" 2>&1
# Navigate to the repository directory:
cd "deprecate_repo_dir" || return 1
# Configure Git for the repository:
configure_git "$5"
echo "Updating repository README..." >> "$5" 2>&1
# Add deprecation notice to the beginning of the repository's README:
sed -i "1 i\## Attention\n\n:warning: **$2** :warning:\n\n<br>\n\n* * *\n" README.md
# Commit the changes:
git add README.md && git commit -m "Deprecate package" >> "$5" 2>&1
if [[ "$?" -ne 0 ]]; then
echo "Encountered an error when updating repository README." >> "$5" 2>&1
return 1
fi
# Push the changes:
git push "https://$3:$4@github.com/$1.git" main >> "$5" 2>&1
if [[ "$?" -ne 0 ]]; then
echo "Encountered an error when updating repository README." >> "$5" 2>&1
return 1
fi
echo "Successfully updated repository README." >> "$5" 2>&1
echo "Archiving repository..." >> "$5" 2>&1
# Archive the repository on GitHub:
curl -u "$3:$4" -X PATCH -H 'Accept: application/vnd.github.v3+json' "https://api.github.com/repos/$1" -d '{"archived":"true"}' >> "$5" 2>&1
if [[ "$?" -ne 0 ]]; then
echo "Encountered an error when archiving repository." >> "$5" 2>&1
return 1
fi
echo "Successfully archived repository." >> "$5" 2>&1
# Return to parent directory:
cd .. || return 1
# Remove the cloned repository:
rm -rf "./deprecate_repo_dir"
echo "Successfully deprecated repository." >> "$5" 2>&1
return 0
}
# Main execution sequence.
main() {
start_heartbeat "${heartbeat_interval}"
# Configure npm:
configure_npm "${npm_token}" "${log_file}"
if [[ "$?" -ne 0 ]]; then
on_error 1
fi
# Deprecate packages...
for pkg in $pkgs; do
# Normalize the package name to allow for both npm and GitHub deprecation:
pkg=$(normalize_package_name "${pkg}")
# Deprecate the package on npm:
npm_deprecate "@stdlib/${pkg}" "${deprecation_message}" "${log_file}"
if [[ "$?" -ne 0 ]]; then
on_error 1
fi
# Deprecate the package on GitHub:
github_deprecate "stdlib-js/${pkg}" "${deprecation_message}" "${github_user}" "${github_token}" "${log_file}"
if [[ "$?" -ne 0 ]]; then
on_error 1
fi
done
cleanup
print_success
exit 0
}
# Set an error handler to print captured output and perform any clean-up tasks:
trap 'on_error' ERR
# Run main:
main