feat(tooling): move redhat packaging out to own step (#273 #837 #1038)

* add patch-package so we can patch a node_modules package

* generate patch to disable build-id contents for RPM package

* move patch-package command to post-install script

* regenerate patch file

package.json

@@ -164,10 +164,13 @@
     "electron-winstaller": "^5.0.0",
     "eslint-plugin-github": "^4.10.1",
     "markdownlint-cli": "^0.32.2",
+    "patch-package": "^8.0.0",
+    "postinstall-postinstall": "^2.1.0",
     "reserved-words": "^0.1.2",
     "tsconfig-paths": "^3.9.0"
   },
   "optionalDependencies": {
-    "electron-installer-debian": "3.2.0"
+    "electron-installer-debian": "3.2.0",
+    "electron-installer-redhat": "3.4.0"
   }
 }

patches/electron-installer-redhat+3.4.0.patch

@@ -0,0 +1,10 @@
+diff --git a/node_modules/electron-installer-redhat/resources/spec.ejs b/node_modules/electron-installer-redhat/resources/spec.ejs
+index e07a8a3..486f59e 100644
+--- a/node_modules/electron-installer-redhat/resources/spec.ejs
++++ b/node_modules/electron-installer-redhat/resources/spec.ejs
+@@ -1,4 +1,5 @@
+ %define _binary_payload w<%= compressionLevel %>.xzdio
++%define _build_id_links none
+
+ %if "%{_host_cpu}" != "%{_target_cpu}"
+ %global __strip /bin/true

script/electron-builder-linux.yml

@@ -11,13 +11,5 @@ linux:
     # see https://github.com/shiftkey/desktop/issues/72 for more details
     - x-scheme-handler/x-github-desktop-dev-auth
   target:
-    - rpm
     - AppImage
-  maintainer: 'GitHub, Inc <opensource+desktop@github.com>'
-rpm:
-  depends:
-    # dugite-native dependencies
-    - libcurl
-    # keytar dependencies
-    - libsecret
-    - gnome-keyring
+  maintainer: 'Brendan Forster<github@brendanforster.com>'

script/package-electron-builder.ts

@@ -40,7 +40,7 @@ export async function packageElectronBuilder(): Promise<Array<string>> {
 
   const appImageInstaller = `${distRoot}/GitHubDesktop-linux-*.AppImage`
 
-  let files = await globPromise(appImageInstaller)
+  const files = await globPromise(appImageInstaller)
   if (files.length !== 1) {
     return Promise.reject(
       `Expected one AppImage installer but instead found '${files.join(
@@ -51,18 +51,5 @@ export async function packageElectronBuilder(): Promise<Array<string>> {
 
   const appImageInstallerPath = files[0]
 
-  const rpmInstaller = `${distRoot}/GitHubDesktop-linux-*.rpm`
-
-  files = await globPromise(rpmInstaller)
-  if (files.length !== 1) {
-    return Promise.reject(
-      `Expected one RPM installer but instead found '${files.join(
-        ', '
-      )}' - exiting...`
-    )
-  }
-
-  const rpmInstallerPath = files[0]
-
-  return Promise.resolve([appImageInstallerPath, rpmInstallerPath])
+  return Promise.resolve([appImageInstallerPath])
 }

script/package-redhat.ts

@@ -0,0 +1,97 @@
+import { promisify } from 'util'
+import { join } from 'path'
+
+import glob = require('glob')
+const globPromise = promisify(glob)
+
+import { rename } from 'fs-extra'
+
+import { getVersion } from '../app/package-info'
+import { getDistPath, getDistRoot } from './dist-info'
+
+const distRoot = getDistRoot()
+
+// best guess based on documentation
+type RedhatOptions = {
+  // required
+  src: string
+  dest: string
+  arch: 'x86_64'
+  // optional
+  description?: string
+  productDescription?: string
+  categories?: Array<string>
+  icon?: any
+  scripts?: {
+    pre?: string
+    post?: string
+    preun?: string
+    postun?: string
+  }
+  homepage?: string
+  mimeType?: Array<string>
+  requires?: Array<string>
+}
+
+const options: RedhatOptions = {
+  src: getDistPath(),
+  dest: distRoot,
+  arch: 'x86_64',
+  description: 'Simple collaboration from your desktop',
+  productDescription:
+    'This is the unofficial port of GitHub Desktop for Linux distributions',
+  categories: ['GNOME', 'GTK', 'Development'],
+  requires: [
+    // dugite-native dependencies
+    '(libcurl or libcurl4)',
+    // keytar dependencies
+    'libsecret',
+    'gnome-keyring',
+  ],
+  icon: {
+    '256x256': 'app/static/logos/256x256.png',
+    '512x512': 'app/static/logos/512x512.png',
+    '1024x1024': 'app/static/logos/1024x1024.png',
+  },
+  scripts: {
+    post: 'script/resources/rpm/post.sh',
+    preun: 'script/resources/rpm/preun.sh',
+  },
+  homepage: 'https://github.com/shiftkey/desktop',
+  mimeType: [
+    'x-scheme-handler/x-github-client',
+    'x-scheme-handler/x-github-desktop-auth',
+    // workaround for handling OAuth flow until we figure out what we're doing
+    // with the development OAuth details
+    //
+    // see https://github.com/shiftkey/desktop/issues/72 for more details
+    'x-scheme-handler/x-github-desktop-dev-auth',
+  ],
+}
+
+export async function packageRedhat(): Promise<string> {
+  if (process.platform === 'win32') {
+    return Promise.reject('Windows is not supported')
+  }
+
+  const installer = require('electron-installer-redhat')
+
+  await installer(options)
+  const installersPath = `${distRoot}/github-desktop*.rpm`
+
+  const files = await globPromise(installersPath)
+
+  if (files.length !== 1) {
+    return Promise.reject(
+      `Expected one file but instead found '${files.join(', ')}' - exiting...`
+    )
+  }
+
+  const oldPath = files[0]
+
+  const newFileName = `GitHubDesktop-linux-${getVersion()}.rpm`
+  const newPath = join(distRoot, newFileName)
+  await rename(oldPath, newPath)
+
+  return Promise.resolve(newPath)
+}

script/package.ts

@@ -32,6 +32,7 @@ import { assertNonNullable } from '../app/src/lib/fatal-error'
 
 import { packageElectronBuilder } from './package-electron-builder'
 import { packageDebian } from './package-debian'
+import { packageRedhat } from './package-redhat'
 
 const distPath = getDistPath()
 const productName = getProductName()
@@ -217,16 +218,21 @@ async function packageLinux() {
     console.log('Updating file mode for chrome-sandbox…')
     await chmod(helperPath, 0o4755)
   }
+  try {
+    const files = await packageElectronBuilder()
+    const debianPackage = await packageDebian()
+    const redhatPackage = await packageRedhat()
 
-  const files = await packageElectronBuilder()
-  const debianPackage = await packageDebian()
+    const installers = [...files, debianPackage, redhatPackage]
 
-  const installers = [...files, debianPackage]
+    console.log(`Installers created:`)
+    for (const installer of installers) {
+      console.log(` - ${installer}`)
+    }
 
-  console.log(`Installers created:`)
-  for (const installer of installers) {
-    console.log(` - ${installer}`)
+    generateChecksums(installers)
+  } catch (err) {
+    console.error('A problem occurred with the packaging step', err)
+    process.exit(1)
   }
-
-  generateChecksums(installers)
 }

script/post-install.ts

@@ -69,4 +69,12 @@ findYarnVersion(path => {
   if (result.status !== 0) {
     process.exit(result.status || 1)
   }
+
+  if (process.platform === 'linux') {
+    result = spawnSync('node', getYarnArgs([path, 'patch-package']), options)
+
+    if (result.status !== 0) {
+      process.exit(result.status || 1)
+    }
+  }
 })

script/resources/rpm/post.sh

@@ -0,0 +1,12 @@
+#!/bin/bash
+
+INSTALL_DIR="/usr/lib/github-desktop"
+CLI_DIR="$INSTALL_DIR/resources/app/static"
+
+# add executable permissions for CLI interface
+chmod +x "$CLI_DIR"/github || :
+
+# create symbolic links to /usr/bin directory
+ln -f -s "$CLI_DIR"/github /usr/bin || :
+
+exit 0

script/resources/rpm/preun.sh

@@ -0,0 +1,8 @@
+#!/bin/bash
+
+BASE_FILE="/usr/bin/github"
+
+# remove symbolic links in /usr/bin directory
+test -f ${BASE_FILE} && unlink ${BASE_FILE}
+
+exit 0