Feat/#6/build app

.env.example

@@ -0,0 +1 @@
+GH_TOKEN = 

.gitignore

@@ -4,8 +4,9 @@ node_modules
 
 
 # local env files
-.env.local
-.env.*.local
+.env
+.env.*
+!.env.example
 
 # Log files
 npm-debug.log*

README.md

@@ -10,4 +10,18 @@
 
 ## Build for production
 
-`npm run electron:build`
+`npm run electron:build`
+
+# Releases
+
+> ⚠️ Every new release published will notify users and update there electron app
+
+## Github token
+
+Create a `.env` file at the root of your local project. Copy the content of `.env.example` and put your [Github token](https://github.com/settings/tokens/new) in.
+
+## Release process
+1. Update app version in the `package.json` following the [Semantic Versioning](https://semver.org/) guidelines.
+2. Commit and push the app version update on a dedicated branch using this pattern: `"release/: {version_number}"`.
+3. When the branch is **ready and merged**, run the following command on the `main` branch: `npm run gh-publish`.
+4. A **pre-release** should be created in the github repo and can be release.

package.json

@@ -1,23 +1,32 @@
 {
   "name": "git-view",
-  "version": "0.1.0",
+  "version": "0.1.3",
   "private": true,
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/ecvdbdx/git-view.git"
+  },
   "scripts": {
     "serve": "vue-cli-service serve",
     "build": "vue-cli-service build",
     "lint": "vue-cli-service lint",
-    "electron:build": "vue-cli-service electron:build",
+    "electron:build": "vue-cli-service electron:build -w -m",
     "electron:serve": "vue-cli-service electron:serve",
     "postinstall": "electron-builder install-app-deps",
     "postuninstall": "electron-builder install-app-deps",
     "prepare": "husky install",
-    "test": "jest"
+    "test": "jest",
+    "gh-publish": "vue-cli-service electron:build -w -m -p always"
   },
   "main": "background.js",
   "dependencies": {
     "@vueuse/core": "^7.5.3",
     "core-js": "^3.6.5",
     "localforage": "^1.10.0",
+    "electron-log": "^4.4.4",
+    "electron-simple-updater": "^2.0.11",
+    "electron-updater": "^4.6.1",
+    "update-electron-app": "^2.0.1",
     "vue": "^3.0.0",
     "vue-router": "^4.0.12"
   },

src/App.vue

@@ -7,7 +7,6 @@ import 'windi.css';
 
 export default {
   name: 'App',
-  components: {},
 };
 </script>
 

src/background.js

@@ -2,6 +2,7 @@
 
 import { app, BrowserWindow, ipcMain, protocol } from 'electron';
 import installExtension, { VUEJS3_DEVTOOLS } from 'electron-devtools-installer';
+import { autoUpdater } from 'electron-updater';
 import { createProtocol } from 'vue-cli-plugin-electron-builder/lib';
 
 import CustomEvents from './events';
@@ -68,6 +69,7 @@ app.on('ready', async () => {
     }
   }
   createWindow();
+  autoUpdater.checkForUpdatesAndNotify();
 });
 
 // Exit cleanly on request from parent process in development mode.

vue.config.js

@@ -2,6 +2,9 @@ module.exports = {
   pluginOptions: {
     electronBuilder: {
       nodeIntegration: true,
+      builderOptions: {
+        publish: ['github'],
+      },
     },
   },
 };