Fix and improve auto update

.github/workflows/release.yml

@@ -4,14 +4,16 @@ on:
   push:
     branches:
       - master
+      - fix-auto-update # FIXME remove
 
 jobs:
   release:
     runs-on: ${{ matrix.os }}
 
     strategy:
       matrix:
-       os: [windows-2019, ubuntu-18.04, macos-latest]
+        os: [macos-latest]
+        # os: [windows-2019, ubuntu-18.04, macos-latest] FIXME restore
 
     steps:
       - name: Check out Git repository

.gitignore

@@ -1,9 +1,8 @@
 .DS_Store
 dist/electron/*
+dist/electron/dev-app-update.yml
 dist/web/*
-build/*
-!build/icons
-!build/entitlements.mac.plist
+build/output/*
 node_modules/
 npm-debug.log
 npm-debug.log.*

README.md

@@ -6,7 +6,17 @@
 
 ### Installation
 
-Please refer to this page to install client on Windows, Linux (deb), macOS : [https://welcome.papermatter.app/downloads/](https://welcome.papermatter.app/downloads/)
+You can download and install client from this page (Windows, Linux, macOS): [https://welcome.papermatter.app/downloads/](https://welcome.papermatter.app/downloads/)
+
+### Logs location
+
+In case you report a bug, it could be useful to join the log files. The easiest way to get them is to display *Advanced* menu by hitting `Alt` key (not needed on macOS) and click on *Open logs folder* item.
+
+If app can't be run, you can also find them by manually opening this folder:
+
+- Linux: ~/.config/paper-matter-import-export/logs/
+- macOS: ~/Library/Logs/paper-matter-import-export/
+- Windows: %USERPROFILE%\AppData\Roaming\paper-matter-import-export\logs\
 
 ## For developers
 
@@ -22,9 +32,11 @@ Please refer to this page to install client on Windows, Linux (deb), macOS : [ht
 
     npm run dev
 
-#### Debug app run
+#### Debug local run
+
+Useful logs should appears inside the terminal used to run the app.
 
-During dev you can remote debug the app by copying the debugger url which appears in the console at app run.
+You can also remote debug the app by copying the debugger url which appears in the console at app run.
 
     # line which appears in console at app run
     Debugger listening on ws://127.0.0.1:5858/0b935d7b-0f11-4c23-92f7-221310dfbaa0
@@ -34,6 +46,26 @@ To attach debugger in Chrome, open this url:
 
 _For more infos see https://simulatedgreg.gitbooks.io/electron-vue/content/en/debugging-production.html_
 
+#### Debug update process
+
+_Run all command from sme Terminal for set ENV VAR to be preserved_
+
+1. Create a test repo with a README.md on Github
+1. Update `package.json` > `version` to a very high number (e.g. 100.0.0, make sure it doesn't match an already published release for this repo)
+1. Update `package.json` > `build.publish` to use the test repo
+1. Comment condition to run `autoUpdater.checkForUpdates()` inside `/src/main/index.js`
+1. Set Github token to access test repo: `export GH_TOKEN=XXX` (token need repo scope)
+1. Publish app to a Github draft release: `electron-builder -p always`
+1. Edit and publish release on Github
+1. Restore old value for `package.json` > `version`
+1. Copy `dev-app-update.yml` to `dist/electron/dev-app-update.yml` and update values to use test repo
+1. (optional) Set ENV VAR to help debug electron-builder process: `export DEBUG=electron-builder`
+1. (Linux only) Set APPIMAGE ENV VAR: `export APPIMAGE=true`
+1. (Mac only) App notarization is needed to test full update process, you have to set `API_KEY_ID` and `API_KEY_ISSUER_ID` (theses values can be generated/retrieved from https://appstoreconnect.apple.com/access/api)
+1. Run app in dev mode `npm run dev` to test update process partially or build app `npm run build` and run it to test full update process
+
+You should see logs related to update process popping in the terminal
+
 ### Run tests
 
 #### Unit tests
@@ -44,17 +76,18 @@ _With [Karma](https://karma-runner.github.io/latest/index.html) test runner, [Mo
 
 ### Release and build process on CI
 
- 1. Create a draft release on Github
-   * tag should be on master and named with `version` prefixed with a `v` (eg. `v1.0.0`)
-   * name should be `version` (eg. `1.0.0`)
- 2. Update package.json `version` (eg. `1.0.0`) and push
- 3. :warning: Wait for built app to be uploaded by CI to draft release :warning:
- 4. Publish and tag release on Github
+ 1. Update package.json `version` (eg. `1.0.0`) and push
+ 1. :warning: Wait for draft release to be created and built app to be attached to it :warning:
+ 1. Complete and publish/tag release on Github
 
 #### Debug app build locally
 
-    # Produce simple executable without full installer in /dist.
+    # Produce simple executable without full installer in /build/output.
     npm run build:dir
+    # You can run unpackaged app by running executable
+    cd build/output/linux-unpacked/
+    ./paper-matter-import-export
+    # Useful logs may appears in terminal during app execution
 
 # Credits
 

dev-app-update.yml

@@ -0,0 +1,5 @@
+# Copy this file inside dist/electron to test electron update
+# Update the file accordingly to the test repo url, e.g.: https://github.com/repo-owner/repo-name
+owner: repo-owner # CHANGEME
+repo: repo-name # CHANGEMEN
+provider: github