ci: 👷 add zip files to github releases (#1593)

Co-authored-by: Joshua Hemphill <[email protected]>
Co-authored-by: Guillaume Chau <[email protected]>

Author: josh-hemphill

.circleci/config.yml

@@ -13,9 +13,9 @@ jobs:
       # Download and cache dependencies
       - restore_cache:
           keys:
-          - v3-dependencies-{{ checksum "yarn.lock" }}
-          # fallback to using the latest cache if no exact match is found
-          - v3-dependencies-
+            - v3-dependencies-{{ checksum "yarn.lock" }}
+            # fallback to using the latest cache if no exact match is found
+            - v3-dependencies-
 
       - run: yarn install --pure-lockfile
 
@@ -27,7 +27,7 @@ jobs:
           key: v3-dependencies-{{ checksum "yarn.lock" }}
 
       # run tests!
-      - run: yarn test
+      - run: yarn build && yarn test
 
       - store_artifacts:
           path: cypress/videos

.eslintrc.js

@@ -60,6 +60,7 @@ module.exports = {
       files: [
         'release.js',
         'sign-firefox.js',
+        'extension-zips.js',
         'packages/build-tools/**',
         'packages/shell-electron/**',
         '**webpack.config.js',

.github/workflows/tagged-release.yml

@@ -0,0 +1,42 @@
+name: Create binary for release
+
+on:
+  push:
+    tags:
+      - "v*"
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v2
+        with:
+          node-version: 14.x
+
+      - name: Set up lerna yarn cache
+        uses: actions/cache@v2
+        with:
+          path: |
+            node_modules
+            */*/node_modules
+            ~/.cache/yarn
+            ~/.cache/Cypress
+          key: ${{ runner.os }}-${{ hashFiles('**/yarn.lock') }}
+
+      - name: Install yarn dependencies
+        if: steps.cache.outputs.cache-hit != 'true'
+        run: yarn install --pure-lockfile
+
+      - name: Build the extension
+        run: yarn run build && node release.js && yarn run test && yarn run zip
+
+      - name: Release
+        uses: softprops/action-gh-release@v1
+        if: startsWith(github.ref, 'refs/tags/')
+        with:
+          files: |
+            dist/devtools-*

extension-zips.js

@@ -0,0 +1,137 @@
+// require modules
+const fs = require('fs')
+const path = require('path')
+const archiver = require('archiver')
+const IS_CI = !!(process.env.CIRCLECI || process.env.GITHUB_ACTIONS)
+const ProgressBar = !IS_CI ? require('progress') : {}
+const readDirGlob = !IS_CI ? require('readdir-glob') : {}
+
+const INCLUDE_GLOBS = [
+  'build/**',
+  'icons/**',
+  'popups/**',
+  'devtools.html',
+  'devtools-background.html',
+  'manifest.json',
+  'package.json',
+]
+// SKIP_GLOBS makes glob searches more efficient
+const SKIP_DIR_GLOBS = ['node_modules', 'src']
+
+function bytesToSize (bytes) {
+  const sizes = ['Bytes', 'KB', 'MB', 'GB', 'TB']
+  if (bytes === 0) return '0 Byte'
+  const i = parseInt(Math.floor(Math.log(bytes) / Math.log(1024)))
+  return Math.round(bytes / Math.pow(1024, i), 2) + ' ' + sizes[i]
+}
+
+(async () => {
+  await writeZip('devtools-chrome.zip', 'shell-chrome')
+  await writeZip('devtools-firefox.zip', 'shell-chrome')
+
+  async function writeZip (fileName, packageDir) {
+    // create a file to stream archive data to.
+    const output = fs.createWriteStream(path.join(__dirname, 'dist', fileName))
+    const archive = archiver('zip', {
+      zlib: { level: 9 }, // Sets the compression level.
+    })
+
+    if (!IS_CI) {
+      const status = {
+        total: 0,
+        cFile: '...',
+        cSize: '0 Bytes',
+        tBytes: 0,
+        tSize: '0 Bytes',
+      }
+
+      async function parseFileStats () {
+        return new Promise((resolve, reject) => {
+          const globber = readDirGlob(path.join('packages', packageDir),
+            { pattern: INCLUDE_GLOBS, skip: SKIP_DIR_GLOBS, mark: true, stat: true })
+          globber.on('match', match => {
+            if (!match.stat.isDirectory()) status.total++
+          })
+          globber.on('error', err => {
+            reject(err)
+          })
+          globber.on('end', () => {
+            resolve()
+          })
+        })
+      }
+      await parseFileStats().catch(err => {
+        console.error(err)
+        process.exit(1)
+      })
+
+      const bar = new ProgressBar(`${fileName} @ :tSize [:bar] :current/:total :percent +:cFile@:cSize`, {
+        width: 18,
+        incomplete: ' ',
+        total: status.total,
+      })
+      bar.tick(0, status)
+
+      archive.on('entry', (entry) => {
+        if (!entry.stats.isDirectory()) {
+          const n = entry.name
+          status.written++
+          status.cFile = n.length > 14
+            ? '...' + n.slice(n.length - 11)
+            : n
+          status.cSize = bytesToSize(entry.stats.size)
+          status.tBytes += entry.stats.size
+          status.tSize = bytesToSize(status.tBytes)
+          bar.tick(1, status)
+        }
+      })
+    }
+
+    const end = new Promise((resolve) => {
+      // listen for all archive data to be written
+      // 'close' event is fired only when a file descriptor is involved
+      output.on('close', () => {
+        if (archive.pointer() < 1000) {
+          console.warn(`Zip file (${fileName}) is only ${archive.pointer()} bytes`)
+        }
+        resolve()
+      })
+    })
+
+    // This event is fired when the data source is drained no matter what was the data source.
+    // It is not part of this library but rather from the NodeJS Stream API.
+    // @see: https://nodejs.org/api/stream.html#stream_event_end
+    output.on('end', function () {
+      'nothing'
+    })
+
+    // good practice to catch warnings (ie stat failures and other non-blocking errors)
+    archive.on('warning', function (err) {
+      if (err.code !== 'ENOENT') {
+        // throw error
+        console.error(err)
+        process.exit(1)
+      }
+    })
+
+    // good practice to catch this error explicitly
+    archive.on('error', function (err) {
+      console.error(err)
+      process.exit(1)
+    })
+
+    // pipe archive data to the file
+    archive.pipe(output)
+
+    INCLUDE_GLOBS.forEach(glob => {
+      // append files from a glob pattern
+      archive.glob(glob, { cwd: path.join('packages', packageDir), skip: SKIP_DIR_GLOBS })
+    })
+
+    // finalize the archive (ie we are done appending files but streams have to finish yet)
+    // 'close', 'end' or 'finish' may be fired right after calling this method so register to them beforehand
+    archive.finalize()
+
+    await end
+  }
+})()

package.json

@@ -15,9 +15,7 @@
     "build:watch": "lerna run build --scope @vue-devtools/app-backend* --scope @vue-devtools/shared-* --scope @vue/devtools-api && lerna run build:watch --stream --no-sort --concurrency 99",
     "lint": "eslint --ext .js,.ts,.vue .",
     "run:firefox": "web-ext run -s packages/shell-chrome -a dist -i src",
-    "zip": "npm run zip:chrome && npm run zip:firefox",
-    "zip:chrome": "cd packages && zip -r -FS ../dist/chrome.zip shell-chrome -x *src/* -x *webpack.config.js -x *node_modules/*",
-    "zip:firefox": "web-ext build -s packages/shell-chrome -a dist -i src --overwrite-dest",
+    "zip": "node ./extension-zips.js",
     "sign:firefox": "node ./sign-firefox.js",
     "release": "npm run test && node release.js && npm run build && npm run zip && npm run pub",
     "release:beta": "cross-env RELEASE_CHANNEL=beta npm run release && npm run sign:firefox",
@@ -51,6 +49,7 @@
     "@typescript-eslint/parser": "^4.23.0",
     "@vue/eslint-config-standard": "^6.0.0",
     "@vue/eslint-config-typescript": "^7.0.0",
+    "archiver": "^5.3.0",
     "autoprefixer": "^9.1.5",
     "concurrently": "^5.1.0",
     "cross-env": "^5.2.0",
@@ -82,4 +81,4 @@
   "engines": {
     "node": ">=8.10"
   }
-}
+}

packages/build-tools/src/createConfig.js

@@ -186,7 +186,7 @@ exports.createConfig = (config, target = { chrome: 52, firefox: 48 }) => {
               safari10: true,
             },
           },
-          parallel: true,
+          parallel: false,
         }),
       ],
     }

release.js

@@ -4,14 +4,18 @@ const semver = require('semver')
 const pkg = require('./package.json')
 const manifest = require('./packages/shell-chrome/manifest.json')
 
+const IS_CI = !!(process.env.CIRCLECI || process.env.GITHUB_ACTIONS)
+
 const curVersion = pkg.version
 
 ;(async () => {
-  const { newVersion } = await inquirer.prompt([{
-    type: 'input',
-    name: 'newVersion',
-    message: `Please provide a version (current: ${curVersion}):`,
-  }])
+  const { newVersion } = IS_CI
+    ? { newVersion: curVersion }
+    : await inquirer.prompt([{
+      type: 'input',
+      name: 'newVersion',
+      message: `Please provide a version (current: ${curVersion}):`,
+    }])
 
   if (!semver.valid(newVersion)) {
     console.error(`Invalid version: ${newVersion}`)
@@ -23,11 +27,13 @@ const curVersion = pkg.version
     process.exit(1)
   }
 
-  const { yes } = await inquirer.prompt([{
-    name: 'yes',
-    message: `Release ${newVersion}?`,
-    type: 'confirm',
-  }])
+  const { yes } = IS_CI
+    ? { yes: true }
+    : await inquirer.prompt([{
+      name: 'yes',
+      message: `Release ${newVersion}?`,
+      type: 'confirm',
+    }])
 
   if (yes) {
     const isBeta = newVersion.includes('beta')

tsconfig.json

@@ -2,9 +2,14 @@
   "compilerOptions": {
     "baseUrl": ".",
     "paths": {
-      "@back/*": ["packages/app-backend-core/src/*"],
-      "@front/*": ["packages/app-frontend/src/*"],
+      "@back/*": [
+        "packages/app-backend-core/src/*"
+      ],
+      "@front/*": [
+        "packages/app-frontend/src/*"
+      ],
     },
+    "outDir": "lib",
     "moduleResolution": "node",
     "allowSyntheticDefaultImports": true,
     "esModuleInterop": true,
@@ -30,4 +35,4 @@
   "exclude": [
     "node_modules"
   ],
-}
+}