Support deploying arm64 builds

.github/workflows/ci.yml

@@ -93,6 +93,7 @@ jobs:
       - name: Publish production app
         run: yarn run publish
         env:
+          npm_config_arch: ${{ matrix.arch }}
           DESKTOPBOT_TOKEN: ${{ secrets.DESKTOPBOT_TOKEN }}
           WINDOWS_CERT_PASSWORD: ${{ secrets.WINDOWS_CERT_PASSWORD }}
           KEY_PASSWORD: ${{ secrets.KEY_PASSWORD }}

README.md

@@ -11,6 +11,7 @@ uses [React](https://reactjs.org/).
 Download the official installer for your operating system:
 
  - [macOS](https://central.github.com/deployments/desktop/desktop/latest/darwin)
+ - [macOS (Apple Silicon)](https://central.github.com/deployments/desktop/desktop/latest/darwin-arm64)
  - [Windows](https://central.github.com/deployments/desktop/desktop/latest/win32)
  - [Windows machine-wide install](https://central.github.com/deployments/desktop/desktop/latest/win32?format=msi)
 
@@ -27,6 +28,7 @@ Want to test out new features and get fixes before everyone else? Install the
 beta channel to get access to early builds of Desktop:
 
  - [macOS](https://central.github.com/deployments/desktop/desktop/latest/darwin?env=beta)
+ - [macOS (Apple Silicon)](https://central.github.com/deployments/desktop/desktop/latest/darwin-arm64?env=beta)
  - [Windows](https://central.github.com/deployments/desktop/desktop/latest/win32?env=beta)
 
 The release notes for the latest beta versions are available [here](https://desktop.github.com/release-notes/?env=beta).

app/src/lib/feature-flag.ts

@@ -165,3 +165,8 @@ export function enableCherryPicking(): boolean {
 export function enableTextDiffExpansion(): boolean {
   return enableDevelopmentFeatures()
 }
+
+/** Should we allow apps running from Rosetta to auto-update to ARM64 builds? */
+export function enableUpdateFromRosettaToARM64(): boolean {
+  return false
+}

app/src/ui/lib/update-store.ts

@@ -14,6 +14,7 @@ import { parseError } from '../../lib/squirrel-error-parser'
 import { ReleaseSummary } from '../../models/release-notes'
 import { generateReleaseSummary } from '../../lib/release-notes'
 import { setNumber, getNumber } from '../../lib/local-storage'
+import { enableUpdateFromRosettaToARM64 } from '../../lib/feature-flag'
 
 /** The states the auto updater can be in. */
 export enum UpdateStatus {
@@ -160,10 +161,24 @@ class UpdateStore {
       return
     }
 
+    let updatesURL = __UPDATES_URL__
+
+    // If the app is running under Rosetta (i.e. it's a macOS x64 binary running
+    // on an arm64 machine), we need to tweak the update URL here to point at
+    // the arm64 binary.
+    if (
+      enableUpdateFromRosettaToARM64() &&
+      remote.app.runningUnderRosettaTranslation === true
+    ) {
+      const url = new URL(updatesURL)
+      url.searchParams.set('architecture', 'arm64')
+      updatesURL = url.toString()
+    }
+
     this.userInitiatedUpdate = !inBackground
 
     try {
-      autoUpdater.setFeedURL({ url: __UPDATES_URL__ })
+      autoUpdater.setFeedURL({ url: updatesURL })
       autoUpdater.checkForUpdates()
     } catch (e) {
       this.emitError(e)

script/dist-info.ts

@@ -1,6 +1,5 @@
 import * as Path from 'path'
 import * as Fs from 'fs'
-import * as os from 'os'
 
 import { getProductName, getVersion } from '../app/package-info'
 import { getReleaseBranchName } from './build-platforms'
@@ -17,17 +16,9 @@ export function getDistRoot() {
 }
 
 export function getDistPath() {
-  let arch = os.arch()
-
-  if (process.env.npm_config_arch) {
-    // If a specific npm_config_arch is set, we use that one instead of the OS arch (to support cross compilation)
-    console.log('npm_config_arch detected: ' + process.env.npm_config_arch)
-    arch = process.env.npm_config_arch
-  }
-
   return Path.join(
     getDistRoot(),
-    `${getExecutableName()}-${process.platform}-${arch}`
+    `${getExecutableName()}-${process.platform}-${getArchitecture()}`
   )
 }
 
@@ -44,7 +35,7 @@ export function getExecutableName() {
 }
 
 export function getOSXZipName() {
-  return `${productName}.zip`
+  return `${productName}-${getArchitecture()}.zip`
 }
 
 export function getOSXZipPath() {
@@ -53,7 +44,7 @@ export function getOSXZipPath() {
 
 export function getWindowsInstallerName() {
   const productName = getExecutableName()
-  return `${productName}Setup.msi`
+  return `${productName}Setup-${getArchitecture()}.msi`
 }
 
 export function getWindowsInstallerPath() {
@@ -62,15 +53,18 @@ export function getWindowsInstallerPath() {
 
 export function getWindowsStandaloneName() {
   const productName = getExecutableName()
-  return `${productName}Setup.exe`
+  return `${productName}Setup-${getArchitecture()}.exe`
 }
 
 export function getWindowsStandalonePath() {
   return Path.join(getDistPath(), '..', 'installer', getWindowsStandaloneName())
 }
 
-export function getWindowsFullNugetPackageName() {
-  return `${getWindowsIdentifierName()}-${version}-full.nupkg`
+export function getWindowsFullNugetPackageName(
+  includeArchitecture: boolean = false
+) {
+  const architectureInfix = includeArchitecture ? `-${getArchitecture()}` : ''
+  return `${getWindowsIdentifierName()}-${version}${architectureInfix}-full.nupkg`
 }
 
 export function getWindowsFullNugetPackagePath() {
@@ -82,8 +76,11 @@ export function getWindowsFullNugetPackagePath() {
   )
 }
 
-export function getWindowsDeltaNugetPackageName() {
-  return `${getWindowsIdentifierName()}-${version}-delta.nupkg`
+export function getWindowsDeltaNugetPackageName(
+  includeArchitecture: boolean = false
+) {
+  const architectureInfix = includeArchitecture ? `-${getArchitecture()}` : ''
+  return `${getWindowsIdentifierName()}-${version}${architectureInfix}-delta.nupkg`
 }
 
 export function getWindowsDeltaNugetPackagePath() {
@@ -142,8 +139,30 @@ export function getReleaseSHA() {
   return pieces[2]
 }
 
+export function getArchitecture(): 'arm64' | 'x64' {
+  // If a specific npm_config_arch is set, we use that one instead of the OS arch (to support cross compilation)
+  if (
+    process.env.npm_config_arch === 'arm64' ||
+    process.env.npm_config_arch === 'x64'
+  ) {
+    return process.env.npm_config_arch
+  }
+
+  if (process.arch === 'arm64') {
+    return 'arm64'
+  }
+
+  // TODO: Check if it's x64 running on an arm64 Windows with IsWow64Process2
+  // More info: https://www.rudyhuyn.com/blog/2017/12/13/how-to-detect-that-your-x86-application-runs-on-windows-on-arm/
+  // Right now (March 3, 2021) is not very important because support for x64
+  // apps on an arm64 Windows is experimental. See:
+  // https://blogs.windows.com/windows-insider/2020/12/10/introducing-x64-emulation-in-preview-for-windows-10-on-arm-pcs-to-the-windows-insider-program/
+
+  return 'x64'
+}
+
 export function getUpdatesURL() {
-  return `https://central.github.com/api/deployments/desktop/desktop/latest?version=${version}&env=${getChannel()}`
+  return `https://central.github.com/api/deployments/desktop/desktop/latest?version=${version}&env=${getChannel()}&architecture=${getArchitecture()}`
 }
 
 export function shouldMakeDelta() {

script/publish.ts

@@ -74,6 +74,8 @@ function uploadOSXAssets() {
 }
 
 function uploadWindowsAssets() {
+  // For the nuget packages, include the architecture infix in the asset name
+  // when they're uploaded.
   const uploads = [
     upload(
       distInfo.getWindowsInstallerName(),
@@ -84,15 +86,15 @@ function uploadWindowsAssets() {
       distInfo.getWindowsStandalonePath()
     ),
     upload(
-      distInfo.getWindowsFullNugetPackageName(),
+      distInfo.getWindowsFullNugetPackageName(true),
       distInfo.getWindowsFullNugetPackagePath()
     ),
   ]
 
   if (distInfo.shouldMakeDelta()) {
     uploads.push(
       upload(
-        distInfo.getWindowsDeltaNugetPackageName(),
+        distInfo.getWindowsDeltaNugetPackageName(true),
         distInfo.getWindowsDeltaNugetPackagePath()
       )
     )
@@ -160,10 +162,19 @@ function createSignature(body: any, secret: string) {
   return `sha1=${hmac.digest('hex')}`
 }
 
-function updateDeploy(artifacts: ReadonlyArray<IUploadResult>, secret: string) {
+function getContext() {
+  return (
+    process.platform + (distInfo.getArchitecture() === 'arm64' ? '-arm64' : '')
+  )
+}
+
+function updateDeploy(
+  artifacts: ReadonlyArray<IUploadResult>,
+  secret: string
+): Promise<void> {
   const { rendererSize, mainSize } = distInfo.getBundleSizes()
   const body = {
-    context: process.platform,
+    context: getContext(),
     branch_name: platforms.getReleaseBranchName(),
     artifacts,
     stats: {