Cypress 發(fā)布產(chǎn)物構(gòu)建指南npm 包與 Electron 二進(jìn)制的構(gòu)建、打包與發(fā)布流程【免費(fèi)下載鏈接】cypressFast, easy and reliable testing for anything that runs in a browser.項(xiàng)目地址: https://gitcode.com/GitHub_Trending/cy/cypress本篇圍繞 Cypress 倉(cāng)庫(kù)中的構(gòu)建指南 building-release-artifacts.md 展開(kāi)講清 Cypress 發(fā)布產(chǎn)物的兩大組成——npm 包與二進(jìn)制壓縮包——各自如何構(gòu)建、打包與驗(yàn)證。讀完你能掌握yarn lerna run build-cli、yarn binary-build、yarn binary-package、yarn binary-zip等命令的完整用法與適用平臺(tái)限制并能結(jié)合 scripts/binary/build.ts、scripts/binary/zip.js 等源碼理解產(chǎn)物內(nèi)部的組裝過(guò)程。發(fā)布產(chǎn)物的整體結(jié)構(gòu)Cypress 的cypressnpm 包由兩部分組成二者必須保持同一版本號(hào)npm 包.tgz由 cli 目錄構(gòu)建包含命令行工具cypress、TypeScript 類(lèi)型定義和 Module API最終用戶通過(guò) npm/Yarn/pnpm 將其安裝到項(xiàng)目的node_modules目錄。二進(jìn)制.zip由 packages 目錄構(gòu)建包含 Electron 應(yīng)用、ffmpeg以及 packages 子目錄中各包的構(gòu)建產(chǎn)物frontend-shared、reporter、web-config不單獨(dú)打包進(jìn)去同時(shí)包含上述所有包的生產(chǎn)依賴(lài)在cli安裝時(shí)或執(zhí)行cypress install時(shí)被下載到系統(tǒng)緩存目錄生產(chǎn)環(huán)境下若本地未緩存會(huì)從 Cypress CDN 拉取。該指南覆蓋了這兩種產(chǎn)物的構(gòu)建方式并額外提供了打包、冒煙測(cè)試、上傳與緩存清理等配套流程。構(gòu)建 npm 包指南原文特別提示以下兩步在 CI 中已自動(dòng)化按正式發(fā)布流程見(jiàn) release-process.md走時(shí)不需要你手動(dòng)執(zhí)行。構(gòu)建一個(gè) npm 包只需要兩步遞增根 package.json 中的version運(yùn)行yarn lerna run build-cli。這兩步實(shí)際完成的工作構(gòu)建cypressnpm 包將代碼轉(zhuǎn)譯為 ES5以兼容常見(jiàn)的 Node 版本結(jié)果輸出到 cli/build 目錄。從源碼看build-cli腳本定義在 cli/package.json 中build: rollup -c, postbuild: yarn make-bin-executable yarn sync-build-dist yarn prepare-package-json yarn bundle-ct-frameworks, build-cli: rollup -c yarn postbuild,即先用 cli/rollup.config.mjs 完成 Rollup 打包隨后依次執(zhí)行 bin 可執(zhí)行化處理、產(chǎn)物同步、package.json 準(zhǔn)備cli/scripts/prepare-package-json.ts與組件測(cè)試框架的框架打包c(diǎn)li/scripts/bundle-ct-frameworks.ts保證 npm 包內(nèi)容完整可發(fā)布。構(gòu)建二進(jìn)制同樣地二進(jìn)制的構(gòu)建步驟在 CI 中已自動(dòng)化。npm 包必須有同版本的二進(jìn)制與之對(duì)應(yīng)生產(chǎn)環(huán)境下若本地未緩存會(huì)從 CDN 檢索。本地構(gòu)建的入口命令見(jiàn)根 package.json 的scripts命令作用腳本定義yarn binary-build構(gòu)建二進(jìn)制cross-env NODE_OPTIONS--max_old_space_size8192 node ./scripts/binary.js buildyarn binary-package打包electron 打包二進(jìn)制cross-env NODE_OPTIONS--max_old_space_size8192 node ./scripts/binary.js packageyarn binary-zip將構(gòu)建好的二進(jìn)制壓縮為 zipnode ./scripts/binary.js zipyarn binary-smoke-test對(duì)構(gòu)建產(chǎn)物做冒煙測(cè)試node ./scripts/binary.js smokeyarn binary-deploybuild → zip → upload 一條龍node ./scripts/binary.js deployyarn binary-purge清理某版本各平臺(tái)的 CDN 緩存node ./scripts/binary.js purge-version注意binary-build與binary-package都通過(guò)cross-env注入了NODE_OPTIONS--max_old_space_size8192因?yàn)闃?gòu)建過(guò)程內(nèi)存占用較高。平臺(tái)選擇可以在 Linux 上構(gòu)建 Cypress 二進(jìn)制與 CI 相同的方式——在yarn docker容器內(nèi)運(yùn)行yarn binary-build和yarn binary-package。倉(cāng)庫(kù)根目錄提供了 docker-compose.yml 支撐該容器環(huán)境。macOS 本地構(gòu)建需要在鑰匙串中擁有代碼簽名證書(shū)按 Apple 官方代碼簽名指南申請(qǐng)。另外由于公證notarization需要 Apple Developer Program 賬號(hào)本地構(gòu)建時(shí)通常應(yīng)設(shè)置SKIP_NOTARIZATION1跳過(guò)公證。CI 中的代碼簽名細(xì)節(jié)見(jiàn) code-signing.md。構(gòu)建階段內(nèi)部做了什么源碼級(jí)解讀yarn binary-build最終調(diào)用 scripts/binary/index.js 中deploy.build再進(jìn)入 scripts/binary/build.ts 的buildCypressApp。其流程與源碼注釋高度對(duì)應(yīng)禁止交叉構(gòu)建if (platform ! os.platform())直接拋錯(cuò)Attempting to cross-build, which is not supported——這正是指南要求在哪個(gè)平臺(tái)構(gòu)建哪個(gè)平臺(tái)產(chǎn)物、或用 docker 構(gòu)建 Linux 版的底層原因見(jiàn) scripts/binary/build.ts#L77-L80清理與符號(hào)鏈接刪除TMP_BUILD_DIR、build/與packages/electron/dist并將build符號(hào)鏈接到系統(tǒng)臨時(shí)目錄下的cypress-build/platform/build路徑常量定義在 scripts/binary/meta.ts 的TMP_BUILD_DIR、buildRootDir構(gòu)建各子包把目標(biāo)version寫(xiě)回根package.json保證 V8 快照與版本正確然后并發(fā)執(zhí)行yarn lerna run build與yarn lerna run build-prod并發(fā)度為min(4, os.availableParallelism())拷貝到 distpackages.copyAllToDist把各包產(chǎn)物拷貝進(jìn) dist 目錄并拷貝 patches 目錄過(guò)濾掉.dev.patch因?yàn)樯a(chǎn)安裝只會(huì)應(yīng)用生產(chǎn)補(bǔ)丁同時(shí)拷貝yarn.lock保證安裝一致性精簡(jiǎn)生產(chǎn)依賴(lài)剔除devDependencies、lint-staged等字段后寫(xiě)入 dist 的package.jsonpostinstall只保留patch-package再執(zhí)行yarn --production瘦身用del刪除各依賴(lài)包中的測(cè)試目錄如pixelmatch/test、exif-parser/test等、.ts源文件與開(kāi)發(fā)用補(bǔ)丁寫(xiě)入運(yùn)行時(shí)入口生成 dist 的index.jsrequire(./packages/server/index.js)與包含electronVersion/electronNodeVersion的package.json構(gòu)建后自驗(yàn)證testDistVersion在 dist 目錄執(zhí)行node index.js --version并與目標(biāo)版本比對(duì)testStaticAssets校驗(yàn)靜態(tài)資源任何不一致都會(huì)讓構(gòu)建失敗。yarn binary-package則調(diào)用packageElectronAppscripts/binary/build.ts#L237移除node_modules/.bin、開(kāi)發(fā)用 Electron 應(yīng)用目錄等打包后無(wú)用的內(nèi)容通過(guò)electron-builder以publish: never、asar: false配置進(jìn)行應(yīng)用打包注釋說(shuō)明因 electron-builder 不會(huì)拷貝packages/*/node_modules中的嵌套目錄故不使用 asarWindows 路徑長(zhǎng)度防護(hù)checkMaxPathLength按默認(rèn)緩存位置 260 字符上限檢查 dist 內(nèi)所有相對(duì)路徑超限即報(bào)錯(cuò)要求提升hoist或刪除文件scripts/binary/build.ts#L45-L70macOS GateKeeper 校驗(yàn)當(dāng)platform darwin且未跳過(guò)簽名時(shí)用spctl -a -vvvv驗(yàn)證應(yīng)用簽名失敗即拋 Verifying App via GateKeeper failedscripts/binary/build.ts#L309-L326最后用du -d 1統(tǒng)計(jì)各包大小并做性能追蹤便于控制 Test Runner 體積。各平臺(tái)產(chǎn)物目錄約定由 scripts/binary/meta.ts 統(tǒng)一管理macOS 為build/macM1 為build/mac-arm64下的Cypress.appLinux 為build/linux-unpackedarm64 為linux-arm64-unpackedWindows 為build/win-unpacked見(jiàn)meta.buildDir實(shí)現(xiàn)。冒煙測(cè)試構(gòu)建完成后建議跑yarn binary-smoke-test。對(duì)應(yīng) scripts/binary/index.js 的smoke方法在無(wú)顯示環(huán)境下自動(dòng)啟動(dòng) xvfbxvfb.isNeeded()然后執(zhí)行testExecutableVersion——調(diào)用構(gòu)建產(chǎn)物的可執(zhí)行文件加--versionLinux 沙箱環(huán)境會(huì)追加--no-sandbox斷言輸出與構(gòu)建版本一致再對(duì)應(yīng)用目錄執(zhí)行 scripts/binary/smoke.js 的冒煙測(cè)試。打包壓縮二進(jìn)制yarn binary-zip的調(diào)用鏈?zhǔn)莇eploy.zip→meta.zipDir(platform)取待壓縮目錄 →zip.ditto(zipDir, zipPath)。scripts/binary/zip.js 按平臺(tái)分派三種壓縮工具平臺(tái)工具命令要點(diǎn)Linuxzipcd 父目錄 zip -r9 dest Cypress先renameFolder確保頂層目錄名為CypressmacOSdittoditto -c -k --sequesterRsrc --keepParent src dest保留資源分叉并保留頂層目錄Windows7-Zip7z a dest src整個(gè)目錄含頂層Cypress/壓入其中 Linux 與 Windows 路徑在壓縮后會(huì)執(zhí)行checkZipSizescripts/binary/zip.js#L70-L84const MAX_ALLOWED_SIZE_MB os.platform() win32 ? 295 : 256zip 超過(guò) 256MBWindows 295MB直接拋錯(cuò)。源碼注釋特別叮囑修改這個(gè)上限前先查清是什么導(dǎo)致了二進(jìn)制體積增長(zhǎng)并在 PR 中說(shuō)明。發(fā)布流水線與 CDN 校驗(yàn)yarn binary-deploy走完整管線scripts/binary/index.js#L417-L435build→zip→upload。upload將 zip 上傳到 S3 的指定路徑upload.getFullUploadPath隨后通過(guò) scripts/binary/util/upload.js 清理該版本的 Cloudflare 緩存。發(fā)布完成后還有兩級(jí) CDN 校驗(yàn)release流程清單校驗(yàn)checkManifest拉取download.cypress.io/desktop.json確認(rèn)manifest.version與發(fā)布版本一致下載校驗(yàn)checkDownloads對(duì) 5 個(gè)平臺(tái)/架構(gòu)組合linux-x64、linux-arm64、darwin-x64、darwin-arm64、win32-x64逐一HEAD請(qǐng)求確認(rèn)二進(jìn)制存在若有缺失提示用yarn binary-purge --version v清理 Cloudflare 緩存后再用yarn binary-ensure --version v復(fù)查見(jiàn) scripts/binary/index.js#L177-L242。實(shí)用技巧指南 Tips 原文加速打包設(shè)置V8_SNAPSHOT_DISABLE_MINIFY1可縮短二進(jìn)制打包耗時(shí)。從源碼看該開(kāi)關(guān)在 V8 快照工具的 tooling/v8-snapshot/src/setup/config.ts#L95 中被讀取const minify !process.env.V8_SNAPSHOT_DISABLE_MINIFY env prod即跳過(guò)生產(chǎn)環(huán)境對(duì)快照的壓縮步驟以換取速度M1 芯片在 M1 Mac 上打包后若要實(shí)際運(yùn)行該二進(jìn)制需要設(shè)置RESET_ADHOC_SIGNATURE1來(lái)重置臨時(shí)adhoc簽名。小結(jié)Cypress 的發(fā)布產(chǎn)物由 npm 包與二進(jìn)制 zip 雙軌構(gòu)成npm 包只需遞增版本并執(zhí)行yarn lerna run build-cli產(chǎn)出進(jìn)入cli/build二進(jìn)制則通過(guò)yarn binary-build構(gòu)建 dist 并做版本/靜態(tài)資源自驗(yàn)證、yarn binary-packageelectron-builder 打包、平臺(tái)簽名與 GateKeeper 校驗(yàn)、yarn binary-zip平臺(tái)化壓縮并做體積上限檢查三步完成再配合binary-deploy、binary-smoke-test與 CDN 清單/下載校驗(yàn)形成完整閉環(huán)。所有環(huán)節(jié)在 CI 中已自動(dòng)化本地執(zhí)行時(shí)按本文命令即可復(fù)現(xiàn)平臺(tái)限制不支持交叉構(gòu)建、macOS 需簽名證書(shū)、Linux 可走 docker是實(shí)操中最需要留意的約束?！久赓M(fèi)下載鏈接】cypressFast, easy and reliable testing for anything that runs in a browser.項(xiàng)目地址: https://gitcode.com/GitHub_Trending/cy/cypress創(chuàng)作聲明：本文部分內(nèi)容由AI輔助生成（AIGC），僅供參考