aboutsummaryrefslogtreecommitdiff
path: root/PUBLISH.md
diff options
context:
space:
mode:
authorRémy Raes <contact@remyraes.com>2022-01-01 22:30:01 +0100
committerGitHub <noreply@github.com>2022-01-01 22:30:01 +0100
commit1598d8b3510580cd886c884b80a69c7b2bcfa422 (patch)
tree1452eacea43b6e6c6a52d75b8159f4af6588819f /PUBLISH.md
parentb91a1ad65ec617486bc6c99d6334cea249db7e15 (diff)
downloadViper-1598d8b3510580cd886c884b80a69c7b2bcfa422.tar.gz
Viper-1598d8b3510580cd886c884b80a69c7b2bcfa422.zip
chore: Auto updating (#16)
* [chore] adding electron-updater dependency * [feat] adding auto-updating mechanism * [chore] setting package version to v0.8.0 * [fix] restoring original repo URL * [docs] adding some documentation about publishing new releases * [chore] adding publish:windows command * [docs] updating publish instructions with new publish command * [chore] adding publish:linux command * [docs] updating publish instructions * --updatevp, and option to disable auto updates If you want you can set "autoupdates" to false in your config, no GUI tools to do this yet. For the CLI auto updates is off by default and you'll have to use --updatevp. I also removed the snap package, tho whether this stays as a change is still to be discussed. And with the new option I updated the help menu, the man page and everything along else that needs it. * removed "soon" parts of README for auto-updates * [feat] adding French translation for cli.help.updatevp key * confirmation for restarting the app Now instead of automatically updating and restarting the app, which may be slightly confusing to some users, (the app opens then closes and then opens), it now asks whether you want to restart and open the new version. If you say no, instead next time you launch it, it'll be on the new version. If you want to completely disable updates you can disable it in the viper.json file... * [feat] adding French translation for gui.update.available key * added configuration instruction in README Co-authored-by: 0neGal <mail@0negal.com>
Diffstat (limited to 'PUBLISH.md')
-rw-r--r--PUBLISH.md9
1 files changed, 9 insertions, 0 deletions
diff --git a/PUBLISH.md b/PUBLISH.md
new file mode 100644
index 0000000..4d38be4
--- /dev/null
+++ b/PUBLISH.md
@@ -0,0 +1,9 @@
+# Publishing a new release
+
+1. Make sure your code works!
+2. Update `package.json` version
+3. Make sure `package.json`'s `repository.url` key references correct repository
+4. Ensure application builds correctly with `npm run build:[windows/linux]`
+5. Expose `GH_TOKEN` environment var with your Github token
+6. Build and publish with `npm run publish:[windows/linux]`
+7. Edit the draft release message and publish the new release! \ No newline at end of file