-
Notifications
You must be signed in to change notification settings - Fork 0
387 lines (330 loc) · 13.2 KB
/
release.yml
File metadata and controls
387 lines (330 loc) · 13.2 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
name: 🚀 Release & Deployment
# ⚠️ NPM AUTHENTICATION SETUP (Updated December 2025)
#
# NPM Classic tokens have been permanently revoked as of December 9, 2025.
# For CI/CD publishing, choose one of these approaches:
#
# ✅ OPTION 1: OIDC Trusted Publishing (RECOMMENDED - No tokens needed!)
# - Enable at: https://docs.npmjs.com/trusted-publishers
# - See: https://docs.github.com/en/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect
#
# ✅ OPTION 2: Granular Access Token (with 90-day max expiration & Bypass 2FA)
# - Create token: npm token create
# - Permissions: "Publish" with "Bypass 2FA for automation" ENABLED
# - Max expiration: 90 days for security
# - Store as 'NPM_TOKEN' secret in repository settings
#
# ❌ DO NOT USE: Classic tokens (permanently revoked)
#
on:
push:
tags:
- 'v*.*.*'
workflow_dispatch:
inputs:
version:
description: 'Version to release (e.g., 1.0.1)'
required: true
type: string
release_type:
description: 'Type of release'
required: true
default: 'release'
type: choice
options:
- release
- prerelease
draft:
description: 'Create as draft release'
required: false
default: false
type: boolean
env:
NODE_VERSION: '18'
# Global permissions for OIDC
permissions:
id-token: write # Required for OIDC trusted publishing
contents: read # Required to read repository contents
packages: write # Required for npm publish
jobs:
# Job 1: Préparation de la release
prepare-release:
name: 🎯 Prepare Release
runs-on: ubuntu-latest
outputs:
version: ${{ steps.version.outputs.version }}
tag: ${{ steps.version.outputs.tag }}
is-prerelease: ${{ steps.version.outputs.is-prerelease }}
steps:
- name: 📥 Checkout Code
uses: actions/checkout@v4
with:
fetch-depth: 0
- name: 🔍 Determine Version
id: version
run: |
if [[ "${{ github.event_name }}" == "workflow_dispatch" ]]; then
VERSION="${{ github.event.inputs.version }}"
TAG="v$VERSION"
IS_PRERELEASE="${{ github.event.inputs.release_type == 'prerelease' }}"
else
TAG="${{ github.ref_name }}"
VERSION="${TAG#v}"
IS_PRERELEASE=$(echo "$VERSION" | grep -q -E "(alpha|beta|rc)" && echo "true" || echo "false")
fi
echo "version=$VERSION" >> $GITHUB_OUTPUT
echo "tag=$TAG" >> $GITHUB_OUTPUT
echo "is-prerelease=$IS_PRERELEASE" >> $GITHUB_OUTPUT
echo "📦 Preparing release for version: $VERSION"
echo "🏷️ Tag: $TAG"
echo "🔄 Pre-release: $IS_PRERELEASE"
# Job 2: Tests complets avant release
pre-release-tests:
name: 🧪 Pre-Release Validation
runs-on: ubuntu-latest
needs: prepare-release
strategy:
matrix:
node-version: [14, 16, 18, 20]
os: [ubuntu-latest, windows-latest, macos-latest]
steps:
- name: 📥 Checkout Code
uses: actions/checkout@v4
- name: 🔧 Setup Node.js ${{ matrix.node-version }}
uses: actions/setup-node@v4
with:
node-version: ${{ matrix.node-version }}
cache: 'npm'
- name: 🧹 Clean NPM Cache
run: |
npm cache clean --force
echo "✅ NPM cache cleaned"
- name: 📦 Install Dependencies
run: |
# Installation propre pour éviter les problèmes de cache
rm -rf node_modules package-lock.json || true
npm install
npm ci
- name: 🧪 Run Complete Test Suite
run: |
echo "Running tests on ${{ matrix.os }} with Node.js ${{ matrix.node-version }}"
npm test
- name: 📊 Run Performance Benchmarks
run: |
npm run benchmark
echo "✅ Benchmarks completed for ${{ matrix.os }}-${{ matrix.node-version }}"
# Job 3: Audit de sécurité pour release
security-audit:
name: 🔒 Security Audit for Release
runs-on: ubuntu-latest
needs: prepare-release
steps:
- name: 📥 Checkout Code
uses: actions/checkout@v4
- name: 🔧 Setup Node.js
uses: actions/setup-node@v4
with:
node-version: ${{ env.NODE_VERSION }}
cache: 'npm'
- name: 📦 Install Dependencies
run: npm ci
- name: 🔍 NPM Security Audit
run: |
echo "Running security audit for release..."
npm audit --audit-level=high
- name: 🔐 License Compliance Check
run: |
echo "Checking license compliance..."
npx license-checker --summary
echo "✅ License compliance verified"
# Job 4: Construction du package
build-package:
name: 🏗️ Build Release Package
runs-on: ubuntu-latest
needs: [prepare-release, pre-release-tests, security-audit]
steps:
- name: 📥 Checkout Code
uses: actions/checkout@v4
- name: 🔧 Setup Node.js
uses: actions/setup-node@v4
with:
node-version: ${{ env.NODE_VERSION }}
cache: 'npm'
- name: 📦 Install Dependencies
run: npm ci
- name: 🔍 Validate Package Structure
run: |
echo "Validating package structure..."
npm pack --dry-run
# Vérifier les fichiers essentiels
test -f index.js && echo "✅ index.js present"
test -f index.d.ts && echo "✅ TypeScript definitions present"
test -f README.md && echo "✅ README.md present"
test -f LICENSE && echo "✅ LICENSE present"
test -d algorithms && echo "✅ algorithms directory present"
- name: 📊 Generate Release Metrics
run: |
echo "## 📊 Release Metrics" > release-metrics.md
echo "" >> release-metrics.md
# Statistiques du code
echo "### 📈 Code Statistics:" >> release-metrics.md
echo "- Total files: $(find algorithms/ -name "*.js" | wc -l)" >> release-metrics.md
echo "- Lines of code: $(find algorithms/ -name "*.js" -exec wc -l {} \; | awk '{sum+=$1} END {print sum}')" >> release-metrics.md
echo "- Test files: $(find test/ -name "*.js" | wc -l)" >> release-metrics.md
# Exécuter les benchmarks pour les métriques
npm run benchmark > benchmark-output.txt
echo "- Performance baseline captured" >> release-metrics.md
- name: 📦 Create Package Archive
run: |
npm pack
PACKAGE_FILE=$(ls algorith-*.tgz)
echo "Package created: $PACKAGE_FILE"
- name: 📤 Upload Package Artifact
uses: actions/upload-artifact@v4
with:
name: npm-package
path: |
algorith-*.tgz
release-metrics.md
benchmark-output.txt
retention-days: 90
# Job 5: Création de la release GitHub
create-release:
name: 🎉 Create GitHub Release
runs-on: ubuntu-latest
needs: [prepare-release, build-package]
permissions:
contents: write # Required to create releases
steps:
- name: 📥 Checkout Code
uses: actions/checkout@v4
with:
fetch-depth: 0
- name: 📥 Download Package Artifact
uses: actions/download-artifact@v4
with:
name: npm-package
- name: 📝 Generate Release Notes
id: release-notes
run: |
echo "Generating release notes for ${{ needs.prepare-release.outputs.version }}..."
# Générer les notes de release depuis le CHANGELOG
if [ -f CHANGELOG.md ]; then
# Extraire les notes pour cette version
sed -n "/## \[${{ needs.prepare-release.outputs.version }}\]/,/## \[/p" CHANGELOG.md | sed '$d' > release-notes.md
else
echo "## What's New in ${{ needs.prepare-release.outputs.version }}" > release-notes.md
echo "" >> release-notes.md
echo "See [CHANGELOG.md](./CHANGELOG.md) for full details." >> release-notes.md
fi
# Ajouter les métriques de performance
echo "" >> release-notes.md
echo "## 📊 Performance Metrics" >> release-notes.md
echo "\`\`\`" >> release-notes.md
grep "ops/sec" benchmark-output.txt >> release-notes.md
echo "\`\`\`" >> release-notes.md
# Ajouter les informations de test
echo "" >> release-notes.md
echo "## ✅ Quality Assurance" >> release-notes.md
echo "- All tests passing across Node.js 14, 16, 18, 20" >> release-notes.md
echo "- Cross-platform compatibility (Linux, Windows, macOS)" >> release-notes.md
echo "- Security audit passed" >> release-notes.md
echo "- Performance benchmarks validated" >> release-notes.md
- name: 🎉 Create Release
uses: softprops/action-gh-release@v1
with:
tag_name: ${{ needs.prepare-release.outputs.tag }}
name: Release ${{ needs.prepare-release.outputs.version }}
body_path: release-notes.md
draft: ${{ github.event.inputs.draft == 'true' }}
prerelease: ${{ needs.prepare-release.outputs.is-prerelease == 'true' }}
files: |
algorith-*.tgz
release-metrics.md
benchmark-output.txt
generate_release_notes: true
# Job 6: Publication sur NPM
publish-npm:
name: 📦 Publish to NPM
runs-on: ubuntu-latest
needs: [prepare-release, create-release]
steps:
- name: 📥 Checkout Code
uses: actions/checkout@v4
- name: 🔧 Setup Node.js with OIDC
uses: actions/setup-node@v4
with:
node-version: ${{ env.NODE_VERSION }}
cache: 'npm'
registry-url: 'https://registry.npmjs.org'
- name: 📦 Install Dependencies
run: npm ci
- name: 📝 Enable NPM Provenance
run: |
npm pkg set publishConfig.provenance=true
echo "✅ NPM provenance tracking enabled"
- name: 📦 Publish to NPM (OIDC)
run: |
echo "🔐 Publishing with OIDC trusted publishing..."
if [[ "${{ needs.prepare-release.outputs.is-prerelease }}" == "true" ]]; then
echo "Publishing pre-release to npm..."
npm publish --tag beta
else
echo "Publishing stable release to npm..."
npm publish
fi
echo "🎉 Successfully published algorith@${{ needs.prepare-release.outputs.version }} to NPM!"
- name: 📢 Post-Publish Verification
run: |
echo "Verifying npm publication..."
sleep 30 # Attendre la propagation
npm view algorith@${{ needs.prepare-release.outputs.version }}
echo "✅ Package verified on NPM registry"
- name: 📋 Setup for OIDC Trusted Publishing
if: ${{ env.NODE_AUTH_TOKEN == '' }}
run: |
echo "ℹ️ OIDC Trusted Publishing is configured"
echo "🔐 Token automatically injected by actions/setup-node"
# Job 7: Post-release actions
post-release:
name: 🎊 Post-Release Actions
runs-on: ubuntu-latest
needs: [prepare-release, publish-npm]
steps:
- name: 📥 Checkout Code
uses: actions/checkout@v4
- name: 📊 Update Release Dashboard
run: |
echo "## 🎉 Release ${{ needs.prepare-release.outputs.version }} Completed!" >> $GITHUB_STEP_SUMMARY
echo "" >> $GITHUB_STEP_SUMMARY
echo "### 📦 Package Information:" >> $GITHUB_STEP_SUMMARY
echo "- **NPM Package**: [algorith@${{ needs.prepare-release.outputs.version }}](https://www.npmjs.com/package/algorith)" >> $GITHUB_STEP_SUMMARY
echo "- **GitHub Release**: [${{ needs.prepare-release.outputs.tag }}](https://github.com/${{ github.repository }}/releases/tag/${{ needs.prepare-release.outputs.tag }})" >> $GITHUB_STEP_SUMMARY
echo "- **Installation**: \`npm install algorith@${{ needs.prepare-release.outputs.version }}\`" >> $GITHUB_STEP_SUMMARY
echo "" >> $GITHUB_STEP_SUMMARY
echo "### 🚀 Next Steps:" >> $GITHUB_STEP_SUMMARY
echo "1. Update dependent projects" >> $GITHUB_STEP_SUMMARY
echo "2. Announce release on social media" >> $GITHUB_STEP_SUMMARY
echo "3. Update documentation sites" >> $GITHUB_STEP_SUMMARY
echo "4. Monitor for issues" >> $GITHUB_STEP_SUMMARY
- name: 🔄 Prepare Next Development Cycle
run: |
echo "Release ${{ needs.prepare-release.outputs.version }} deployment completed successfully!"
echo "Ready for next development cycle."
# Job 8: Rollback capability
rollback-check:
name: 🚨 Rollback Readiness
runs-on: ubuntu-latest
needs: [prepare-release, publish-npm]
if: failure()
steps:
- name: 🚨 Rollback Information
run: |
echo "## 🚨 Release Failed - Rollback Information" >> $GITHUB_STEP_SUMMARY
echo "" >> $GITHUB_STEP_SUMMARY
echo "If manual rollback is needed:" >> $GITHUB_STEP_SUMMARY
echo "1. **Unpublish from NPM**: \`npm unpublish algorith@${{ needs.prepare-release.outputs.version }}\`" >> $GITHUB_STEP_SUMMARY
echo "2. **Delete GitHub Release**: Go to releases page and delete" >> $GITHUB_STEP_SUMMARY
echo "3. **Delete Git Tag**: \`git tag -d ${{ needs.prepare-release.outputs.tag }} && git push origin :refs/tags/${{ needs.prepare-release.outputs.tag }}\`" >> $GITHUB_STEP_SUMMARY
echo "" >> $GITHUB_STEP_SUMMARY
echo "⚠️ **Note**: NPM unpublish is only available within 24 hours of publish" >> $GITHUB_STEP_SUMMARY