-
Notifications
You must be signed in to change notification settings - Fork 65
572 lines (465 loc) · 20.8 KB
/
deploy.yml
File metadata and controls
572 lines (465 loc) · 20.8 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
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
name: Deploy CD
run-name: ${{ github.actor }} is running Deploy CD
on:
push:
branches: # Allow list of deployable tags and branches. Note that all allow-listed branches cannot include any `/` characters
- next
env:
rid: ${{ github.run_id }}-${{ github.run_number }}
token: ${{ secrets.NPM_TOKEN }}
GH_TOKEN: ${{ secrets.GH_TOKEN }}
GIT_AUTHOR_NAME: ${{ github.actor }}
GIT_AUTHOR_EMAIL: ${{ github.actor }}@users.noreply.github.com
HUSKY: 0
jobs:
analyze-changes:
name: Determine Changed Packages
runs-on: ubuntu-latest
outputs:
node-changed: ${{ steps.generate-package-matrix-node-changed.outputs.node-changed }}
node-recursive: ${{ steps.generate-package-matrix-node-recursive.outputs.node-recursive }}
yarn-changed: ${{ steps.generate-package-matrix-yarn-changed.outputs.yarn-changed }}
yarn-recursive: ${{ steps.generate-package-matrix-yarn-recursive.outputs.yarn-recursive }}
steps:
- name: Checkout Project
uses: actions/checkout@v4
with:
fetch-depth: 0 # Fetch all history for package comparison
- name: Setup Node
uses: actions/setup-node@v4
with:
node-version-file: ".nvmrc"
registry-url: "https://registry.npmjs.org"
cache: "yarn"
- name: Install Dependencies
uses: actions/cache@v4
id: cache-dependencies
with:
path: "**/node_modules"
key: node-modules-${{ hashFiles('./yarn.lock') }}
- name: Install if cache miss
if: steps.cache-dependencies.outputs.cache-hit != 'true'
run: yarn install --immutable
# Generate package matrix for changed packages
- id: generate-package-matrix-node-changed
name: Generate Package Matrix (Node Changed)
run: echo "node-changed=$(yarn package-tools list --mode node --since ${{ github.event.before }})" >> $GITHUB_OUTPUT
- id: generate-package-matrix-node-recursive
name: Generate Package Matrix (Node Recursive)
run: echo "node-recursive=$(yarn package-tools list --mode node --recursive --since ${{ github.event.before }})" >> $GITHUB_OUTPUT
- id: generate-package-matrix-yarn-changed
name: Generate Package Matrix (Yarn Changed)
run: echo "yarn-changed=$(yarn package-tools list --since ${{ github.event.before }})" >> $GITHUB_OUTPUT
- id: generate-package-matrix-yarn-recursive
name: Generate Package Matrix (Yarn Recursive)
run: echo "yarn-recursive=$(yarn package-tools list --recursive --since ${{ github.event.before }})" >> $GITHUB_OUTPUT
- name: Display Package Matrix
run: |
echo "Changed packages (node): ${{ steps.generate-package-matrix-node-changed.outputs.node-changed }}"
echo "Changed packages + dependents (node): ${{ steps.generate-package-matrix-node-recursive.outputs.node-recursive }}"
echo "Changed packages (yarn): ${{ steps.generate-package-matrix-yarn-changed.outputs.yarn-changed }}"
echo "Changed packages + dependents (yarn): ${{ steps.generate-package-matrix-yarn-recursive.outputs.yarn-recursive }}"
publish-npm:
name: Publish to NPM
needs: analyze-changes
runs-on: ubuntu-latest
outputs:
published: ${{ steps.check-changes.outputs.has_changes }}
published_packages: ${{ steps.get-published-versions.outputs.published_packages }}
steps:
- name: Checkout Project
uses: actions/checkout@v4
- name: Setup Node
uses: actions/setup-node@v4
with:
node-version-file: ".nvmrc"
registry-url: "https://registry.npmjs.org"
cache: "yarn"
- name: Restore Dependencies Cache
uses: actions/cache/restore@v4
with:
path: "**/node_modules"
key: node-modules-${{ hashFiles('./yarn.lock') }}
- name: Check for Changed Packages
id: check-changes
run: |
PACKAGES='${{ needs.analyze-changes.outputs.yarn-recursive }}'
if [ -z "$PACKAGES" ] || [ "$PACKAGES" == "{}" ] || [ "$PACKAGES" == "[]" ]; then
echo "has_changes=false" >> $GITHUB_OUTPUT
echo "⚠️ No packages have changed - skipping deployment"
else
echo "has_changes=true" >> $GITHUB_OUTPUT
echo "✅ Found changed packages: $PACKAGES"
fi
- name: No Changes Detected
if: steps.check-changes.outputs.has_changes == 'false'
run: |
echo "=========================================="
echo "🔍 No packages changed in this push"
echo "=========================================="
echo "Deployment skipped - no changes detected since last push"
echo "Compared against: ${{ github.event.before }}"
echo "=========================================="
- name: Add NPM token to .yarnrc.yml file
if: steps.check-changes.outputs.has_changes == 'true'
run: |
echo "npmAuthToken: ${{ env.token }}" >> ~/.yarnrc.yml
- name: Sync and Increment Package Versions
if: steps.check-changes.outputs.has_changes == 'true'
run: |
yarn package-tools sync --tag ${GITHUB_REF##*/}
yarn package-tools increment --packages ${{ needs.analyze-changes.outputs.node-recursive }} --tag ${GITHUB_REF##*/}
- name: Build Changed Packages
if: steps.check-changes.outputs.has_changes == 'true'
run: yarn run build:prod
- name: Cache Built Distributables
if: steps.check-changes.outputs.has_changes == 'true'
uses: actions/cache/save@v4
with:
path: "**/dist"
key: dist-${{ env.rid }}
- name: Identify Publishable Packages
if: steps.check-changes.outputs.has_changes == 'true'
id: identify-publishable
run: |
CHANGED_PACKAGES='${{ needs.analyze-changes.outputs.yarn-recursive }}'
echo "Identifying packages with deploy:npm script..."
PUBLISHABLE_PACKAGES=""
# Parse the JSON array of changed packages
if [ "$CHANGED_PACKAGES" != "[]" ] && [ -n "$CHANGED_PACKAGES" ]; then
for PKG in $(echo "$CHANGED_PACKAGES" | jq -r '.[]' 2>/dev/null); do
# Find the package.json for this package
PKG_PATH=$(yarn workspaces list --json | jq -r "select(.name == \"$PKG\") | .location")
if [ -n "$PKG_PATH" ] && [ -f "$PKG_PATH/package.json" ]; then
# Check if package.json has a deploy:npm script
HAS_DEPLOY=$(jq -r '.scripts["deploy:npm"] // empty' "$PKG_PATH/package.json")
if [ -n "$HAS_DEPLOY" ]; then
echo " ✓ $PKG has deploy:npm script"
if [ -n "$PUBLISHABLE_PACKAGES" ]; then
PUBLISHABLE_PACKAGES="$PUBLISHABLE_PACKAGES,"
fi
PUBLISHABLE_PACKAGES="$PUBLISHABLE_PACKAGES\"$PKG\""
else
echo " ⏭ $PKG skipped (no deploy:npm script)"
fi
fi
done
fi
# Convert to JSON array
if [ -n "$PUBLISHABLE_PACKAGES" ]; then
PUBLISHABLE_JSON="[$PUBLISHABLE_PACKAGES]"
else
PUBLISHABLE_JSON="[]"
fi
echo "publishable_packages=$PUBLISHABLE_JSON" >> $GITHUB_OUTPUT
echo "Publishable packages: $PUBLISHABLE_JSON"
- name: Deploy Packages
if: steps.check-changes.outputs.has_changes == 'true'
id: deploy-packages
run: yarn workspaces foreach -W --from '${{ needs.analyze-changes.outputs.yarn-recursive }}' --verbose run deploy:npm --access public --tag ${GITHUB_REF##*/}
env:
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
- name: Get Published Package Versions
if: steps.check-changes.outputs.has_changes == 'true'
id: get-published-versions
run: |
PUBLISHABLE_PACKAGES='${{ steps.identify-publishable.outputs.publishable_packages }}'
echo "Getting versions for published packages..."
PUBLISHED_WITH_VERSIONS=""
if [ "$PUBLISHABLE_PACKAGES" != "[]" ] && [ -n "$PUBLISHABLE_PACKAGES" ]; then
for PKG in $(echo "$PUBLISHABLE_PACKAGES" | jq -r '.[]' 2>/dev/null); do
# Get the version that was just set by package-tools sync
PKG_PATH=$(yarn workspaces list --json | jq -r "select(.name == \"$PKG\") | .location")
if [ -n "$PKG_PATH" ] && [ -f "$PKG_PATH/package.json" ]; then
VERSION=$(jq -r '.version' "$PKG_PATH/package.json")
if [ -n "$VERSION" ]; then
echo " ✓ $PKG@$VERSION"
if [ -n "$PUBLISHED_WITH_VERSIONS" ]; then
PUBLISHED_WITH_VERSIONS="$PUBLISHED_WITH_VERSIONS,"
fi
PUBLISHED_WITH_VERSIONS="$PUBLISHED_WITH_VERSIONS\"$PKG@$VERSION\""
fi
fi
done
fi
# Convert to JSON array
if [ -n "$PUBLISHED_WITH_VERSIONS" ]; then
PUBLISHED_JSON="[$PUBLISHED_WITH_VERSIONS]"
else
PUBLISHED_JSON="[]"
fi
echo "published_packages=$PUBLISHED_JSON" >> $GITHUB_OUTPUT
echo "Published packages with versions: $PUBLISHED_JSON"
publish-documentation:
name: Publish - Documentation
needs: [publish-npm,analyze-changes]
runs-on: ubuntu-latest
steps:
- name: Documentation Deploy Steps
run: echo "Documentation Deploy Steps"
- name: Checkout Project
uses: actions/checkout@v4
with:
fetch-depth: 0
- name: Setup Node
uses: actions/setup-node@v4
with:
node-version-file: '.nvmrc'
registry-url: 'https://registry.npmjs.org'
cache: 'yarn'
- name: Restore Dependencies Cache
uses: actions/cache/restore@v4
with:
path: '**/node_modules'
key: node-modules-${{ hashFiles('./yarn.lock') }}
- name: Restore Distributables Cache
uses: actions/cache/restore@v4
with:
path: '**/dist'
key: dist-${{ env.rid }}
- name: Synchronize Packages
run: yarn
- name: Build tools and set versions
run: |
yarn package-tools sync --tag ${GITHUB_REF##*/}
- name: Build packages
run: yarn run build:prod
- name: Build samples locally
run: yarn samples:build
- name: Set Git Identity
run: |
git config user.email "${GIT_AUTHOR_EMAIL}"
git config user.name "${GIT_AUTHOR_NAME}"
- name: Get existing changelog from documentation Branch
run: |
git fetch origin documentation
git checkout origin/documentation -- docs/changelog/logs
- name: Update changelog
run: yarn package-tools changelog --packages ${{ needs.analyze-changes.outputs.node-recursive }} --tag ${GITHUB_REF##*/} --commit ${{ github.event.before }}
- name: Update Changelog and Publish Docs Folder
run: |
# Check if there's anything to commit before committing
if [ -n "$(git status --porcelain)" ]; then
git add docs/
git commit -m "chore(docs): update docs"
git push origin HEAD:documentation --force
fi
comment-on-pr:
name: Comment on Merged PR
runs-on: ubuntu-latest
needs: [analyze-changes, publish-npm]
if: needs.publish-npm.outputs.published == 'true'
steps:
- name: Checkout Project
uses: actions/checkout@v4
with:
fetch-depth: 0
- name: Setup Node
uses: actions/setup-node@v4
with:
node-version-file: ".nvmrc"
registry-url: "https://registry.npmjs.org"
cache: "yarn"
- name: Restore Dependencies Cache
uses: actions/cache/restore@v4
with:
path: "**/node_modules"
key: node-modules-${{ hashFiles('./yarn.lock') }}
- name: Find Merged PR
id: find-pr
run: |
# Get the commit SHA
COMMIT_SHA="${{ github.sha }}"
# Find PR associated with this commit
PR_NUMBER=$(gh pr list --state merged --search "$COMMIT_SHA" --json number --jq '.[0].number')
if [ -z "$PR_NUMBER" ]; then
echo "⚠️ No merged PR found for commit $COMMIT_SHA"
echo "pr_found=false" >> $GITHUB_OUTPUT
else
echo "✅ Found merged PR #$PR_NUMBER"
echo "pr_found=true" >> $GITHUB_OUTPUT
echo "pr_number=$PR_NUMBER" >> $GITHUB_OUTPUT
fi
env:
GH_TOKEN: ${{ secrets.GH_TOKEN }}
- name: Get Published Versions
id: get-versions
if: steps.find-pr.outputs.pr_found == 'true'
run: |
PUBLISHED_JSON='${{ needs.publish-npm.outputs.published_packages }}'
VERSION_INFO=""
TAG_LINKS=""
# Check if any packages were published
if [ -z "$PUBLISHED_JSON" ] || [ "$PUBLISHED_JSON" == "[]" ]; then
echo "No packages were published to NPM"
echo "version_info=No packages were published" >> $GITHUB_OUTPUT
echo "tag_links=" >> $GITHUB_OUTPUT
exit 0
fi
echo "Processing published packages from NPM output..."
# Extract package@version strings from JSON array
PUBLISHED_PACKAGES=$(echo "$PUBLISHED_JSON" | jq -r '.[]' 2>/dev/null)
# Iterate through all published packages
for PKG_VERSION in $PUBLISHED_PACKAGES; do
# Skip empty values
if [ -z "$PKG_VERSION" ]; then
continue
fi
# Split package@version
PKG_NAME=$(echo "$PKG_VERSION" | cut -d@ -f1-2)
VERSION=$(echo "$PKG_VERSION" | rev | cut -d@ -f1 | rev)
if [ -n "$VERSION_INFO" ]; then
VERSION_INFO="${VERSION_INFO}\n"
fi
VERSION_INFO="${VERSION_INFO}- \`${PKG_VERSION}\`"
echo " ✓ ${PKG_VERSION}"
# Create tag name: convert @scope/package to scope-package-vX.X.X
TAG_NAME=$(echo "$PKG_NAME" | sed 's/@//g' | sed 's/\//-/g')-v${VERSION}
TAG_URL="${{ github.server_url }}/${{ github.repository }}/releases/tag/${TAG_NAME}"
if [ -n "$TAG_LINKS" ]; then
TAG_LINKS="${TAG_LINKS}\n"
fi
TAG_LINKS="${TAG_LINKS}- [\`${TAG_NAME}\`](${TAG_URL})"
done
# Save to output using heredoc to handle multiline
echo "version_info<<EOF" >> $GITHUB_OUTPUT
echo -e "$VERSION_INFO" >> $GITHUB_OUTPUT
echo "EOF" >> $GITHUB_OUTPUT
echo "tag_links<<EOF" >> $GITHUB_OUTPUT
echo -e "$TAG_LINKS" >> $GITHUB_OUTPUT
echo "EOF" >> $GITHUB_OUTPUT
- name: Comment on PR
if: steps.find-pr.outputs.pr_found == 'true'
run: |
PR_NUMBER="${{ steps.find-pr.outputs.pr_number }}"
VERSION_INFO="${{ steps.get-versions.outputs.version_info }}"
TAG_LINKS="${{ steps.get-versions.outputs.tag_links }}"
TAG_NAME="${GITHUB_REF##*/}"
# Create comment body with proper escaping
cat << 'COMMENT_EOF' > comment.md
## 🚀 Deployment Successful
This PR has been deployed to NPM with tag `TAG_PLACEHOLDER`.
### Published Versions
VERSION_INFO_PLACEHOLDER
### Release Tags
TAG_LINKS_PLACEHOLDER
**Workflow Run:** [RUN_ID_PLACEHOLDER](RUN_URL_PLACEHOLDER)
COMMENT_EOF
# Replace placeholders
sed -i "s|TAG_PLACEHOLDER|${TAG_NAME}|g" comment.md
sed -i "s|VERSION_INFO_PLACEHOLDER|${VERSION_INFO}|g" comment.md
sed -i "s|TAG_LINKS_PLACEHOLDER|${TAG_LINKS}|g" comment.md
sed -i "s|RUN_ID_PLACEHOLDER|${{ github.run_id }}|g" comment.md
sed -i "s|RUN_URL_PLACEHOLDER|${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}|g" comment.md
# Post comment to PR
gh pr comment "$PR_NUMBER" --body-file comment.md
echo "✅ Comment posted to PR #$PR_NUMBER"
env:
GH_TOKEN: ${{ secrets.GH_TOKEN }}
publish-tag:
name: Publish - Tags
runs-on: ubuntu-latest
needs: [analyze-changes, publish-npm]
steps:
- name: Checkout Project
uses: actions/checkout@v4
with:
fetch-depth: 0
- name: Setup Node
uses: actions/setup-node@v4
with:
node-version-file: ".nvmrc"
registry-url: "https://registry.npmjs.org"
cache: "yarn"
- name: Restore Dependencies Cache
uses: actions/cache/restore@v4
with:
path: "**/node_modules"
key: node-modules-${{ hashFiles('./yarn.lock') }}
- name: Restore Distributables Cache
uses: actions/cache/restore@v4
with:
path: "**/dist"
key: dist-${{ env.rid }}
- name: Synchronize Packages
run: yarn
- name: Check if packages were published
id: check-publish
run: |
if [ "${{ needs.publish-npm.outputs.published }}" != "true" ]; then
echo "⚠️ NPM publish was skipped - no tags will be created"
echo "should_tag=false" >> $GITHUB_OUTPUT
else
echo "✅ NPM publish succeeded - proceeding with tagging"
echo "should_tag=true" >> $GITHUB_OUTPUT
fi
- name: Set Git Identity
if: steps.check-publish.outputs.should_tag == 'true'
run: |
git config user.email "${GIT_AUTHOR_EMAIL}"
git config user.name "${GIT_AUTHOR_NAME}"
- name: Create and Push Tags for Main Packages
if: steps.check-publish.outputs.should_tag == 'true'
run: |
COMMIT_MESSAGE="$(git log -1 --oneline --no-decorate)"
COMMIT_HASH="$(git rev-parse HEAD)"
# node-recursive includes both changed packages AND their dependents
# e.g., if @webex/cc-store changes, @webex/cc-widgets will be in this list if it depends on store
PACKAGES='${{ needs.analyze-changes.outputs.node-recursive }}'
# Define the packages we want to tag (only main/published packages)
TAGGABLE_PACKAGES=("@webex/widgets" "@webex/cc-widgets")
echo "=========================================="
echo "Creating tags for main packages"
echo "=========================================="
# Check if any packages were changed
if [ -z "$PACKAGES" ] || [ "$PACKAGES" == "{}" ] || [ "$PACKAGES" == "[]" ]; then
echo "⚠️ No packages changed - skipping tagging"
exit 0
fi
# Extract package names from JSON array
CHANGED_PACKAGES=$(echo "$PACKAGES" | jq -r '.[]' 2>/dev/null || echo "$PACKAGES")
echo "Packages to evaluate (changed + dependents): $CHANGED_PACKAGES"
echo ""
for TAGGABLE_PKG in "${TAGGABLE_PACKAGES[@]}"; do
echo "----------------------------------------"
echo "Checking if $TAGGABLE_PKG needs to be tagged..."
# Check if this package is in the changed packages list (includes dependents)
FOUND=false
for CHANGED_PKG in $CHANGED_PACKAGES; do
if [ "$CHANGED_PKG" == "$TAGGABLE_PKG" ]; then
FOUND=true
break
fi
done
if [ "$FOUND" == "false" ]; then
echo "⏭️ $TAGGABLE_PKG not in publish list - skipping"
continue
fi
echo "✅ $TAGGABLE_PKG needs to be published - creating tag..."
# Get version for this specific package
VERSION=$(yarn package-tools sync --tag ${GITHUB_REF##*/} --packages "$TAGGABLE_PKG" | awk '{print $3}' | tr -d '%' | head -1)
if [ -z "$VERSION" ]; then
echo "⚠️ Could not determine version for $TAGGABLE_PKG, skipping..."
continue
fi
# Create tag name: convert @scope/package to scope-package-vX.X.X
TAG_NAME=$(echo "$TAGGABLE_PKG" | sed 's/@//g' | sed 's/\//-/g')-v${VERSION}
echo "Tag name: $TAG_NAME"
# Check if tag already exists
if git rev-parse "$TAG_NAME" >/dev/null 2>&1; then
echo "⚠️ Tag $TAG_NAME already exists, skipping..."
continue
fi
# Create annotated tag
git tag -a "$TAG_NAME" "$COMMIT_HASH" -m "Release $TAGGABLE_PKG v${VERSION}: $COMMIT_MESSAGE"
# Push tag
if git push origin "$TAG_NAME"; then
echo "✅ Successfully created and pushed tag: $TAG_NAME"
else
echo "❌ Failed to push tag: $TAG_NAME"
fi
echo "----------------------------------------"
done
echo "=========================================="
echo "Tagging complete!"
echo "=========================================="