Merge pull request #4 from heyman/release-channels

Add Beta release channel

electron/config.js

@@ -25,6 +25,7 @@ const schema = {
             "emacsMetaKey": { "enum": [null, "alt", "meta"], default: null },
             "showLineNumberGutter": {type: "boolean", default:true},
             "showFoldGutter": {type: "boolean", default:true},
+            "allowBetaVersions": {type: "boolean", default: false},
         },
     },
 
@@ -45,6 +46,7 @@ const defaults = {
         emacsMetaKey: "meta",
         showLineNumberGutter: true,
         showFoldGutter: true,
+        allowBetaVersions: false,
     },
     theme: "system",
 }

electron/main/auto-update.ts

@@ -1,5 +1,6 @@
 import { autoUpdater } from "electron-updater"
 import { app, dialog, ipcMain } from "electron"
+import CONFIG from "../config"
 
 import { 
     UPDATE_AVAILABLE_EVENT, 
@@ -10,7 +11,7 @@ import {
     UPDATE_START_DOWNLOAD,
     UPDATE_INSTALL_AND_RESTART,
     UPDATE_CHECK_FOR_UPDATES,
- } from '../constants'
+} from '../constants'
 
 
 // will reference the main window
@@ -23,6 +24,7 @@ autoUpdater.logger = log
 autoUpdater.logger.transports.file.level = "info"
 
 autoUpdater.autoDownload = false
+autoUpdater.allowDowngrade = true
 
 autoUpdater.on('error', (error) => {
     window?.webContents.send(UPDATE_ERROR, error == null ? "unknown" : (error.stack || error).toString())
@@ -63,14 +65,33 @@ ipcMain.handle(UPDATE_INSTALL_AND_RESTART, () => {
     setImmediate(() => autoUpdater.quitAndInstall(true, true))
 })
 
-ipcMain.handle(UPDATE_CHECK_FOR_UPDATES, () => {
+
+export function checkForUpdates() {
+    autoUpdater.allowPrerelease = CONFIG.get("settings.allowBetaVersions")
     autoUpdater.checkForUpdates()
     // for development, the autoUpdater will not work, so we need to trigger the event manually
     if (process.env.NODE_ENV === "development") {
         window?.webContents.send(UPDATE_NOT_AVAILABLE_EVENT)
     }
+}
+
+ipcMain.handle(UPDATE_CHECK_FOR_UPDATES, () => {
+    checkForUpdates()
 })
 
 export function initializeAutoUpdate(win) {
     window = win
+
+    /**
+     * To debug auto updates (actually downloading an update won't work), 
+     * uncomment the lines below, and create a dev-app-update.yml with the content:
+     * 
+     * owner: heyman
+     * repo: heynote
+     * provider: github
+     */
+    // Useful for some dev/debugging tasks, but download can
+    // not be validated becuase dev app is not signed
+    //autoUpdater.updateConfigPath = "/Users/heyman/projects/heynote/dev-app-update.yml" //path.join(__dirname, 'dev-app-update.yml');
+    //autoUpdater.forceDevUpdateConfig = true;
 }

electron/main/index.ts

@@ -9,7 +9,7 @@ import { WINDOW_CLOSE_EVENT, SETTINGS_CHANGE_EVENT } from '../constants';
 import CONFIG from "../config"
 import { onBeforeInputEvent } from "../keymap"
 import { isMac } from '../detect-platform';
-import { initializeAutoUpdate } from './auto-update';
+import { initializeAutoUpdate, checkForUpdates } from './auto-update';
 import { fixElectronCors } from './cors';
 
 
@@ -59,6 +59,12 @@ const isDev = !!process.env.VITE_DEV_SERVER_URL
 let currentKeymap = CONFIG.get("settings.keymap")
 let contentSaved = false
 
+// if this version is a beta version, set the release channel to beta
+const isBetaVersion = app.getVersion().includes("beta")
+if (isBetaVersion) {
+    CONFIG.set("settings.allowBetaVersions", true)
+}
+
 
 async function createWindow() {
     // read any stored window settings from config, or use defaults
@@ -203,7 +209,7 @@ ipcMain.handle('buffer-content:saveAndQuit', async (event, content) => {
 })
 
 ipcMain.handle('settings:set', (event, settings) =>  {
-    if (settings.keymap !== CONFIG.get("keymap")) {
+    if (settings.keymap !== CONFIG.get("settings.keymap")) {
         currentKeymap = settings.keymap
     }
     CONFIG.set("settings", settings)

package.json

@@ -14,6 +14,7 @@
   },
   "build": {
     "appId": "com.heynote.app",
+    "generateUpdatesFilesForAllChannels": true,
     "directories": {
       "buildResources": "resources"
     }
@@ -52,7 +53,7 @@
     "electron-builder": "^23.6.0",
     "electron-builder-notarize": "^1.5.1",
     "electron-store": "^8.1.0",
-    "electron-updater": "^5.3.0",
+    "electron-updater": "^6.1.7",
     "fs-jetpack": "^5.1.0",
     "prettier": "^2.8.4",
     "rollup-plugin-license": "^3.0.1",

src/components/App.vue

@@ -121,6 +121,7 @@
             :languageAuto="languageAuto"
             :theme="theme"
             :systemTheme="systemTheme"
+            :allowBetaVersions="settings.allowBetaVersions"
             @toggleTheme="toggleTheme"
             @openLanguageSelector="openLanguageSelector"
             @formatCurrentBlock="formatCurrentBlock"

src/components/StatusBar.vue

@@ -13,6 +13,7 @@
             "languageAuto",
             "theme",
             "systemTheme",
+            "allowBetaVersions",
         ],
 
         components: {
@@ -63,7 +64,7 @@
         >
             <span class="icon icon-format"></span>
         </div>
-        <UpdateStatusItem />
+        <UpdateStatusItem :allowBetaVersions="allowBetaVersions" />
         <div class="status-block theme clickable" @click="$emit('toggleTheme')" title="Toggle dark/light mode">
             <span :class="'icon ' + systemTheme"></span>
         </div>

src/components/UpdateStatusItem.vue

@@ -1,5 +1,9 @@
 <script>
     export default {
+        props: [
+            "allowBetaVersions",
+        ],
+        
         data() {
             return {
                 updateAvailable: false,
@@ -62,6 +66,14 @@
             }
         },
 
+        watch: {
+            allowBetaVersions: {
+                handler: function (newValue) {
+                    this.checkForUpdate()
+                },
+            }
+        },
+
         computed: {
             statusText() {
                 if (this.downloading) {
@@ -123,6 +135,7 @@
             },
 
             checkForUpdate() {
+                this.updateAvailable = false
                 this.checkingForUpdate = true
                 window.heynote.autoUpdate.checkForUpdates()
             }

src/components/settings/Settings.vue

@@ -16,6 +16,7 @@
                 isMac: window.heynote.platform.isMac,
                 showLineNumberGutter: this.initialSettings.showLineNumberGutter,
                 showFoldGutter: this.initialSettings.showFoldGutter,
+                allowBetaVersions: this.initialSettings.allowBetaVersions,
             }
         },
 
@@ -40,6 +41,7 @@
                     showFoldGutter: this.showFoldGutter,
                     keymap: this.keymap,
                     emacsMetaKey: this.metaKey,
+                    allowBetaVersions: this.allowBetaVersions,
                 })
             }
         }
@@ -91,6 +93,20 @@
                         </div>
                     </div>
                 </div>
+                <div class="row">
+                    <div class="entry">
+                        <h2>Beta Versions</h2>
+                        <div class="checkbox">
+                            <input 
+                                type="checkbox" 
+                                id="allowBetaVersions"
+                                v-model="allowBetaVersions" 
+                                @change="updateSettings"
+                            />
+                            <label for="allowBetaVersions">Use beta versions of Heynote</label>
+                        </div>
+                    </div>
+                </div>
             </div>
             <button 
                 @click="$emit('closeSettings')"