Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add auto-updating #65

Merged
merged 12 commits into from
May 22, 2020
Merged

Add auto-updating #65

merged 12 commits into from
May 22, 2020

Conversation

alexkim205
Copy link
Owner

Status Type Env Vars Change
Hold Feature Yes

Problem

Resolves #63.

Solution

https://medium.com/@johndyer24/creating-and-deploying-an-auto-updating-electron-app-for-mac-and-windows-using-electron-builder-6a3982c0cee6

I also want to automate CI deployment of the cask. TODO: update the workflow to also update and push to homebrew-cask.

Before & After Screenshots

BEFORE:
[insert screenshot here]

AFTER:
[insert screenshot here]

Other changes (e.g. bug fixes, UI tweaks, small refactors)

Deploy Notes

Notes regarding deployment of the contained body of work. These should note any
new dependencies, new scripts, etc.

New environment variables:

  • GH_TOKEN : Required for CI publishing. Accessed in package.json.

New scripts:

  • build : Build project but don't publish to Github.
  • deploy : Build project and publish to Github.

New dependencies:

  • electron-updater : [https://www.electron.build/auto-update][https://www.electron.build/auto-update]

New dev dependencies:

@alexkim205 alexkim205 changed the title add electron-updater, add deploy yarn script Add auto-updating May 22, 2020
@alexkim205 alexkim205 self-assigned this May 22, 2020
@alexkim205 alexkim205 marked this pull request as draft May 22, 2020 16:39
@alexkim205 alexkim205 added enhancement New feature or request help wanted Extra attention is needed labels May 22, 2020
@alexkim205 alexkim205 marked this pull request as ready for review May 22, 2020 19:52
@@ -78,6 +87,7 @@
"del": "^5.1.0",
"electron": "^8.2.5",
"electron-builder": "^22.6.0",
"electron-log": "^4.1.4",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Probably want to remove dependencies from README and move it to a DEPENDENCIES.md file because might get to hard to manage listing all these dependencies

Copy link
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a good point, however I don't think this is within the scope of this PR, so I'll create another PR just for reorganizing docs.

@alexkim205 alexkim205 merged commit c1152ef into master May 22, 2020
@alexkim205 alexkim205 deleted the enhance-63-auto-update branch May 22, 2020 21:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request help wanted Extra attention is needed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants