electron-mksnapshot 22.0.0 → 23.0.0

package/.circleci/config.yml

@@ -1,73 +1,114 @@
-# Javascript Node CircleCI 2.0 configuration file
-#
-# Check https://circleci.com/docs/2.0/language-javascript/ for more details
-#
-version: 2
-jobs:
-  install-test-linux:
-    docker:
-      # specify the version you desire here
-      - image: circleci/node:14-browsers
+version: 2.1
 
-      # Specify service dependencies here if necessary
-      # CircleCI maintains a library of pre-built images
-      # documented at https://circleci.com/docs/2.0/circleci-images/
-      # - image: circleci/mongo:3.4.4
-
-    working_directory: ~/repo
+orbs:
+  node: circleci/node@5.1.0
+  win: circleci/windows@5.0.0
 
+commands:
+  install:
     steps:
+      - node/install:
+          node-version: "16.19.0"
+      - run: nvm use 16.19.0
       - checkout
-
-      # Download and cache dependencies
       - restore_cache:
           keys:
-          - v1-dependencies-{{ checksum "package.json" }}
-          # fallback to using the latest cache if no exact match is found
-          - v1-dependencies-
-
-      - run: npm install
-
+            - v1-dependencies-{{ arch }}-{{ checksum "package-lock.json" }}
+            - v1-dependencies-{{ arch }}
+      - when:
+          condition: << pipeline.git.tag >>
+          steps:
+            - run:
+                name: Update Version
+                command: node script/update-version.js << pipeline.git.tag >>
+            - run: npm install
+      - unless:
+          condition: << pipeline.git.tag >>
+          steps:
+            - run:
+                command: npm install
+                environment:
+                  ELECTRON_MKSNAPSHOT_STABLE_FALLBACK: 1
       - save_cache:
           paths:
             - node_modules
-          key: v1-dependencies-{{ checksum "package.json" }}
-
-      # run tests!
+          key: v1-dependencies-{{ arch }}-{{ checksum "package-lock.json" }}
+  test:
+    steps:
       - run: node --version
       - run: npm --version
       - run: npm test
 
-  install-test-osx:
+jobs:
+  test-linux:
+    docker:
+      - image: cimg/base:stable
+    steps:
+      - install
+      - test
+  test-mac:
     macos:
-        xcode: "13.3.0"
+      xcode: "13.3.0"
+    steps:
+      - install
+      - test
+  test-windows:
+    executor:
+      name: win/default
+      shell: bash.exe
+    steps:
+      - install
+      - test
+  release:
+    docker:
+      - image: cimg/node:18.14
     steps:
       - checkout
-
-      # Download and cache dependencies
-      - restore_cache:
-          keys:
-          - v1-mac-dependencies-{{ checksum "package.json" }}
-          # fallback to using the latest cache if no exact match is found
-          - v1-mac-dependencies-
-
-      - run: npm install
-
-      - save_cache:
-          paths:
-            - node_modules
-          key: v1-mac-dependencies-{{ checksum "package.json" }}
-
-      # run tests!
-      - run: node --version
-      - run: npm --version
-      - run: npm test
+      - run:
+          name: Update Version
+          command: node script/update-version.js << pipeline.git.tag >>
+      - run:
+          name: Install Dependencies
+          command: npm ci
+      - run:
+          name: Obtain Publishing Credentials
+          command: npx @continuous-auth/circleci-oidc-github-auth@1.0.4
+      - run:
+          name: Confirm Version Updated
+          command: node -e "if (require('./package.json').version === '0.0.0-development') process.exit(1)"
+      - run:
+          name: Set NPM Credentials
+          command: echo //registry.npmjs.org/:_authToken=${NPM_TOKEN} > ~/.npmrc
+      - run:
+          name: Check NPM Credentials
+          command: npm whoami
+      - run:
+          name: CFA Publish
+          command: node script/publish.js
 
 workflows:
-  version: 2
-  test-linux:
-    jobs:
-      - install-test-linux
-  test-osx:
+  test_and_release:
     jobs:
-      - install-test-osx
+      - test-linux:
+          filters:
+            tags:
+              only: /.*/
+      - test-mac:
+          filters:
+            tags:
+              only: /.*/
+      - test-windows:
+          filters:
+            tags:
+              only: /.*/
+      - release:
+          requires:
+            - test-linux
+            - test-mac
+            - test-windows
+          filters:
+            tags:
+              only: /^v.*/
+            branches:
+              ignore: /.*/
+          context: cfa-release

package/.github/workflows/release.yml

@@ -11,13 +11,14 @@ env:
   GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
 jobs:
-  run_tests:
-    strategy:
-      matrix:
-        os: [ubuntu-latest, macos-latest]
-    runs-on: ${{ matrix.os }}
+  smoke_test:
+    runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@ac593985615ec2ede58e132d2e21d2b1cbd6127c  # tag: v3.3.0
+      - name: Setup Node.js
+        uses: actions/setup-node@64ed1c7eab4cce3362f8c340dee64e5eaeef8f7c  # tag: v3.6.0
+        with:
+          node-version: "16.19.0"
       - name: Update Version
         run: node script/update-version.js ${{ github.event.inputs.version }}
       - name: Install Dependencies
@@ -26,37 +27,15 @@ jobs:
         run: npm test
   create_new_version:
     runs-on: ubuntu-latest
-    needs: run_tests
+    needs: smoke_test
     steps:
-      - uses: actions/checkout@v3
-      - name: Use Node.js v16
-        uses: actions/setup-node@v3
-        with:
-          node-version: 16.x
-          registry-url: 'https://registry.npmjs.org'
-      - name: Check npm credentials
-        run: npm whoami
-        env:
-          NODE_AUTH_TOKEN: ${{ secrets.NPM_AUTH_TOKEN }}
-      - name: Set Git Credentials
-        run: |
-          git config user.name electron-bot
-          git config user.email electron@github.com
-      - name: Update Version
-        run: node script/update-version.js ${{ github.event.inputs.version }}
-      - name: Push Update Commit
-        run: |
-          git add .
-          git commit -m "chore: update version to ${{ github.event.inputs.version }}"
-          git push origin main
+      - uses: actions/checkout@ac593985615ec2ede58e132d2e21d2b1cbd6127c  # tag: v3.3.0
+      # Tag here, the CircleCI workflow will trigger on the new tag and do the CFA publish
       - name: Push New Tag
         run: |
           git tag ${{ github.event.inputs.version }}
           git push origin ${{ github.event.inputs.version }}
+      # TODO - This creates a draft release at the moment
       - name: Create Release
         run: |
-          gh release create ${{ github.event.inputs.version }} -t ${{ github.event.inputs.version }}
-      - name: Publish to npm
-        run: npm publish
-        env:
-          NODE_AUTH_TOKEN: ${{ secrets.NPM_AUTH_TOKEN }}
+          gh release create ${{ github.event.inputs.version }} -t ${{ github.event.inputs.version }} -d

package/.github/workflows/semantic.yml

@@ -7,14 +7,20 @@ on:
       - edited
       - synchronize
 
+permissions:
+  contents: read
+
 jobs:
   main:
+    permissions:
+      pull-requests: read  # for amannn/action-semantic-pull-request to analyze PRs
+      statuses: write  # for amannn/action-semantic-pull-request to mark status of analyzed PR
     name: Validate PR Title
     runs-on: ubuntu-latest
     steps:
       - name: semantic-pull-request
-        uses: amannn/action-semantic-pull-request@v4
+        uses: amannn/action-semantic-pull-request@01d5fd8a8ebb9aafe902c40c53f0f4744f7381eb # tag: v5
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         with:
-          validateSingleCommit: true
+          validateSingleCommit: false

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) Contributors to the Electron project
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,12 +1,11 @@
 # Electron mksnapshot
 
-[![AppVeyor Build status](https://ci.appveyor.com/api/projects/status/ugparq4awqbf4fq5/branch/main?svg=true)](https://ci.appveyor.com/project/electron-bot/mksnapshot/branch/main)
-[![Linux and Mac Build Status](https://circleci.com/gh/electron/mksnapshot/tree/main.svg?style=shield)](https://circleci.com/gh/electron/mksnapshot/tree/main)
+[![CircleCI Status](https://circleci.com/gh/electron/mksnapshot/tree/main.svg?style=shield)](https://circleci.com/gh/electron/mksnapshot/tree/main)
+[![npm:](https://img.shields.io/npm/v/electron-mksnapshot.svg)](https://www.npmjs.com/package/electron-mksnapshot)
 <br>
 [![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat)](http://standardjs.com/)
 [![license:mit](https://img.shields.io/badge/license-mit-blue.svg)](https://opensource.org/licenses/MIT)
 <br>
-[![npm:](https://img.shields.io/npm/v/electron-mksnapshot.svg)](https://www.npmjs.com/package/electron-mksnapshot)
 [![dependencies:?](https://img.shields.io/npm/dm/electron-mksnapshot.svg)](https://www.npmjs.com/package/electron-mksnapshot)
 
 Simple node module to download the `mksnapshot` binaries compatible with

package/download-mksnapshot.js

@@ -5,15 +5,31 @@ const extractZip = require('extract-zip')
 const versionToDownload = require('./package').version
 let archToDownload = process.env.npm_config_arch
 
-if (process.arch.indexOf('arm') === 0 && process.platform !== 'darwin') {
-  console.log(`WARNING: mksnapshot does not run on ${process.arch}. Download 
-  https://github.com/electron/electron/releases/download/v${versionToDownload}/mksnapshot-v${versionToDownload}-${process.platform}-${process.arch}-x64.zip
-  on a x64 ${process.platform} OS to generate ${archToDownload} snapshots.`)
-  process.exit(1)
+// Refs https://github.com/electron/fiddle-core/blob/1ee2d2737f23fd1012917a249a9444b6db89f1d8/src/versions.ts#L47-L57
+function compareVersions (a, b) {
+  const l = a.compareMain(b)
+  if (l) return l
+  // Electron's approach is nightly -> other prerelease tags -> stable,
+  // so force `nightly` to sort before other prerelease tags.
+  const [prea] = a.prerelease
+  const [preb] = b.prerelease
+  if (prea === 'nightly' && preb !== 'nightly') return -1
+  if (prea !== 'nightly' && preb === 'nightly') return 1
+  return a.comparePre(b)
 }
 
-if (archToDownload && archToDownload.indexOf('arm') === 0 && process.platform !== 'darwin') {
-  archToDownload += '-x64'
+// Refs https://github.com/electron/fiddle-core/blob/1ee2d2737f23fd1012917a249a9444b6db89f1d8/src/versions.ts#L152-L160
+function getLatestStable (releases) {
+  const { parse: semverParse } = require('semver')
+  const semvers = releases.map(({ version }) => semverParse(version)).filter((sem) => Boolean(sem))
+  semvers.sort((a, b) => compareVersions(a, b))
+  let stable
+  for (const ver of semvers.values()) {
+    if (ver.prerelease.length === 0) {
+      stable = ver
+    }
+  }
+  return stable
 }
 
 function download (version) {
@@ -28,6 +44,29 @@ function download (version) {
 }
 
 async function attemptDownload (version) {
+  // Fall back to latest stable if there is not a stamped version, for tests
+  if (version === '0.0.0-development') {
+    if (!process.env.ELECTRON_MKSNAPSHOT_STABLE_FALLBACK) {
+      console.log('WARNING: mksnapshot in development needs the environment variable ELECTRON_MKSNAPSHOT_STABLE_FALLBACK set')
+      process.exit(1)
+    }
+
+    const fetch = require('node-fetch')
+    const releases = await fetch('https://releases.electronjs.org/releases.json').then(response => response.json())
+    version = getLatestStable(releases).version
+  }
+
+  if (process.arch.indexOf('arm') === 0 && process.platform !== 'darwin') {
+    console.log(`WARNING: mksnapshot does not run on ${process.arch}. Download 
+    https://github.com/electron/electron/releases/download/v${version}/mksnapshot-v${version}-${process.platform}-${process.arch}-x64.zip
+    on a x64 ${process.platform} OS to generate ${archToDownload} snapshots.`)
+    process.exit(1)
+  }
+
+  if (archToDownload && archToDownload.indexOf('arm') === 0 && process.platform !== 'darwin') {
+    archToDownload += '-x64'
+  }
+
   try {
     const targetFolder = path.join(__dirname, 'bin')
     const zipPath = await download(version)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "electron-mksnapshot",
-  "version": "22.0.0",
+  "version": "23.0.0",
   "description": "Electron version of the mksnapshot binary",
   "repository": "https://github.com/electron/mksnapshot",
   "bin": {
@@ -19,7 +19,10 @@
     "temp": "^0.8.3"
   },
   "devDependencies": {
+    "@continuous-auth/client": "^2.2.2",
     "mocha": "^10.1.0",
+    "node-fetch": "^2.6.9",
+    "semver": "^7.3.8",
     "standard": "^14.3.1"
   },
   "standard": {
@@ -30,4 +33,4 @@
   "engines": {
     "node": ">=10.5.0"
   }
-}
+}

package/script/publish.js

@@ -0,0 +1,11 @@
+// Publish the package in the CWD with an OTP code from CFA
+const { getOtp } = require('@continuous-auth/client')
+const { spawnSync } = require('child_process')
+
+async function publish () {
+  const { status, stdout } = spawnSync('npm', ['publish', '--otp', await getOtp()])
+  if (status !== 0) console.log(stdout)
+  process.exit(status)
+}
+
+publish()

package/script/update-version.js

@@ -10,8 +10,8 @@ const normalizeVersion = (version = '') => {
 async function updateVersion () {
   const version = normalizeVersion(process.argv[2])
   if (!versionFormat.test(version)) {
-    console.error(`Invalid version ${version}`)
-    process.exit(1)
+    console.error(`Unsupported version ${version} - only major, minor, and patch releases are currently supported`)
+    return
   }
 
   const PJ_PATH = path.join(__dirname, '..', 'package.json')