Auto update and stores (#5)

* wip

* wip

* windows build installer

* win-installer-build working with ffmpeg local path fix, no build in package.json though?

* web auto-update installer

* windows build done

* added mac build info

* set build to .8

* potential final build solution for win/mac

* readme improvement

* snap filepath fix

* .4.

README.md

@@ -1,25 +1,57 @@
 # RenderTune
-RenderTune is a free, open-source electron app that can combine audio + image file(s) into video files. You can render videos from a single audio file or combine multiple audio files into one video. RenderTune offers ordering options if you want to include multiple songs in a single video so you can make sure they appear in the order you wish. You can also specify the output video location, resolution, and aspects such as wheather or not to add padding to the video, and what color to make the background padding.
+RenderTune is a free, open-source electron app that can combine audio + image file(s) into video files. You can render videos from a single audio file or combine multiple audio files into one video. RenderTune offers ordering options if you want to include multiple songs in a single video so you can make sure they appear in the order you wish. You can also specify the output video location, resolution, and aspects such as whether or not to add padding to the video, and what color to make the background padding.
+
+## Availiable on an app store for every OS:
+- Mac Apple Store: https://apps.apple.com/us/app/rendertune/id1552674375
+- Windows Store: https://www.microsoft.com/en-us/p/rendertune/9n5710msppf1?activetab=pivot:overviewtab
+- Linux Snap Store: https://snapcraft.io/rendertune
+
+## Or download files from the releases tab on GitHub:
+- RenderTune-Web-Setup-0.2.7.exe: Windows installer (auto-updates).
+- RenderTune-0.2.7.exe: Windows portable exe (no auto-updates).
+- RenderTune-mac.dmg: Mac OS Installer (auto-updates).
 
 ## How to run RenderTune locally:
-- clone this repo and cd into the folder
+- Clone this repo and cd into the folder
 - If you are on windows I suggest using command prompt, as that can launch electron apps fine, where as Windows Linux Subsystem has troubles launching electron apps. If you are on a mac, download brew and use your mac terminal.
-- run `npm i` and `npm i -g electron` if you haven't already installed electron globally.
-- if you are on mac; run `sh buildffmpeg.sh` to staticlly build a version of ffmpeg that can be sandboxed and distributed to the mac apple store (mas)
-- run `electron .` to start the program
+- Run `npm i` and `npm i -g electron` if you haven't already installed electron globally.
+- Download and setup ffmpeg-mac/ folder (instructions below).
+- Run `electron .` to start the program
+
+## How to install ffmpeg locally for mac (ffmpeg-mac/)
+- If you are on mac; run `sh buildffmpeg.sh` to create the "ffmpeg-mac/" folder and staticlly build a version of ffmpeg that can be sandboxed and distributed to the mac apple store (mas)
+- Verify your local ffmpeg-mac/ folder has no dynamic libraries by running this command: `otool -L ffmpeg-mac/ffmpeg | grep /usr/local`
+- If any files show up after running this command, delete or move those files, redownload the ffmpeg-mac/ folder, then run the 'otool' command again to verify there are no dynamic libraries in your local ffmpeg-mac/ folder. 
+
+## Releasing a new version:
+- Change version number in package.json, make sure that version does not have already have a drafted release in Github, make sure you have all env vars set locally and ffmpeg-mac/ folder if you are on mac.
+- (mac): Mac Apple Store (mas): Change package.json mac build to have mas target, build & sign with `npm run build-mas`, upload .app file for review.
+- (mac): mac-auto-update: Change package.json to have "dmg" and "zip" for mac build targets, remove RenderTune.pkg we crated above if it exists since we don't want to package that inside our build, build & publish by running the command `npm run build-mac-publish`.
+- (win) win-auto-update / win-portable / win-store: On Windows, make sure env vars are set by running `echo %GH_TOKEN%` in command prompt terminal, build nsis-web/portable/appx targets with command `npm run build-win-publish`, sign nsis-web with powershell command and upload for review.
+- (linux): Sign into snap store on terminal, make sure linux build targets is "snap", and run `$ npm run build-snap`, then run `$ snapcraft upload --release=stable dist/rendertune_0.3.23_amd64.snap` new version should now be on snap store.
+
+## Releasing a new version for electron apps with auto-update:
+- Change version number in package.json (this is the bare minimum to change).
+- Make sure you have local vars set for GH_TOKEN, APPLEID, and APPLEIDPASS.
+- (win) Run `electron-builder build --win --publish always` or `npm run build-win-publish` to generate an win installer with auto-update (`dist/nsis-web/RenderTune-Setup-#.#.#.exe`), a portable exe with no auto-update (`dist/RenderTune #.#.#.exe`), and a win-unpacked folder, deploy to github.
+- (mac) Make sure you have your ffmpeg-mac/ folder in your repo root directory. In package.json, change `"build":{"mac":{"target": ["dmg","zip"] }}` to  only include "dmg" and "zip" in the targets. Build the dmg and publish it to Github by running the command `electron-builder build --win --publish always`. The .dmg file will now be an installer for Mac that has auto-update enabled.
 
 ## Releasing new build on Mac Apple Store (mas):
-- compile and build the sandboxed ffmpeg binaries by running the buildffmpeg.sh script with this command: `sh buildffmpeg.sh ` which will create the ffmpeg-mac/ folder.
-- verify your local ffmpeg-mac/ folder has no dynamic libraries by running this command: `otool -L ffmpeg-mac/ffmpeg | grep /usr/local`
-- if any files show up after running this command, delete or move those files, rebuild ffmpeg, and run the command again to verify there are no dynamic libraries in your local ffmpeg-mac/ folder
-- build the mas package with `electron-builder build --mac`
-- sign the mas package by running the mas-sign-script with this command: `sh signmasscript.sh`
-- take the outputted .pkg file and use transporter to upload it to the mac apple store review process
+- Download and setup ffmpeg-mac/ folder (instructions above).
+- In package.json, change `"build":{"mac":{"target": ["mas"] }}` to only include "mas" in the targets, to build the mas file.
+- Sign the mas package by running the mas-sign-script with this command: `sh signmasscript.sh`. This script relies on my Apple computer local keys.
+- Take the signed and outputted .pkg file, use transporter to upload it to the mac apple store, and submit it to the mas review process.
 
 ## Releasing new build on Windows App Store:
 - Build the dist/win-unpacked folder by running the command `electron-builder build --win`
 - Once the windows build has finished, run the following powershell command to tag and create an .appx file:
 ```
 electron-windows-store --input-directory C:\Users\marti\Documents\projects\RenderTune\dist\win-unpacked --output-directory C:\Users\marti\Documents\projects\RenderTuneAppx --package-version 0.2.1.0 --package-name RenderTune --package-display-name 'RenderTune' --publisher-display-name 'martinbarker' --identity-name 1845martinbarker.digify -a C:\Users\marti\Documents\projects\RenderTune-cleanbuild\Resources\
+- Note: To be able to run this powershell command you need to have a Windows SDK downloaded: https://www.electronjs.org/docs/tutorial/windows-store-guide
 ```
 - Take the outputted .appx file and submit it to the Windows Store (make sure to include app tile images in the submission)
+
+## Release new build on linux snap store:
+- Login to snap store from terminal: `$ snapcraft login`
+- Build --linux for snap target: `$ npm run build-linux` this will outputt a .snap file in the dist/ folder.
+- Upload snap target build output with: `snapcraft upload --release=stable dist/rendertune_0.3.23_amd64.snap` (with your new version number)

electron-builder.yml

@@ -1,4 +1,4 @@
-appId: com.example.digify
+appId: com.martinbarker.digifyunique
 publish:
   provider: github
   token: process.env.GH_TOKEN

entitlements.mac.plist

@@ -2,14 +2,11 @@
 <!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
 <plist version="1.0">
 <dict>
-
-	<key>com.apple.security.files.user-selected.read-write</key>
-	<true/>
-	<key>com.apple.security.cs.allow-unsigned-executable-memory</key>
-	<true/>
-	<key>com.apple.security.device.audio-input</key>
-	<true/>
-	<key>com.apple.security.files.user-selected.read-only</key>
-	<true/>
+	<key>com.apple.security.cs.allow-jit</key>
+    <true/>
+    <key>com.apple.security.cs.allow-unsigned-executable-memory</key>
+    <true/>
+    <key>com.apple.security.cs.allow-dyld-environment-variables</key>
+    <true/>
 </dict>
 </plist>

main.js

@@ -1,10 +1,9 @@
 const { app, BrowserWindow, ipcMain, dialog } = require('electron');
-//const { autoUpdater } = require('electron-updater');
+const { autoUpdater } = require('electron-updater');
 const musicMetadata = require('music-metadata');
 var path = require('path');
 const sizeOf = require('image-size');
-require('dotenv').config();
-
+require('dotenv').config({ path: path.resolve(__dirname, '../.env') })
 let mainWindow;
 
 function createWindow() {
@@ -20,19 +19,25 @@ function createWindow() {
         frame: false,
         backgroundColor: '#FFF',
     });
-    mainWindow.loadFile('./src/newindex.html'); //digify mas-attempt-2
-    //mainWindow.loadFile('./src/index.html'); //digify mas-attempt-2
+    mainWindow.loadFile('./src/newindex.html'); 
 
     mainWindow.on('closed', function () {
         mainWindow = null;
     });
 
-    // Open the DevTools. 
-    //mainWindow.webContents.openDevTools()
-
+
     // check if there are any updates availiable once main window is ready. if there are, automatically download 
     mainWindow.once('ready-to-show', () => {
-        //autoUpdater.checkForUpdatesAndNotify();
+        autoUpdater.checkForUpdatesAndNotify();
+    });
+    //notify that update is available
+    autoUpdater.on('update-available', () => {
+        mainWindow.webContents.send('update_available');
+    });
+
+    //notify that update has downloaded
+    autoUpdater.on('update-downloaded', () => {
+        mainWindow.webContents.send('update_downloaded');
     });
 
 }
@@ -58,9 +63,9 @@ ipcMain.on('app_version', (event) => {
     event.sender.send('app_version', { version: app.getVersion() });
 });
 
-//auto-update quiet and install
+//auto-update quit and install
 ipcMain.on('restart_app', () => {
-    //autoUpdater.quitAndInstall();
+    autoUpdater.quitAndInstall();
 });
 
 //open folder dir picker window and return string of folder path