pulsar-edit/pulsar
1
1
Fork 0
mirror of https://github.com/pulsar-edit/pulsar.git synced 2024-09-11 19:17:09 +03:00
Code Issues Packages Projects Releases Wiki Activity
Rolling-version-number-based-on-UTC-commit-date
pulsar/packages/pulsar-updater
History
confused-Techie 52b71d3464 Returns "Developer Instance" in tests
2023-08-17 20:05:51 -07:00
..
spec Returns "Developer Instance" in tests 2023-08-17 20:05:51 -07:00
src Detect when run via yarn start 2023-08-17 19:19:50 -07:00
.gitignore Add Pulsar Updater as core bundled package 2023-07-25 21:15:59 -07:00
package-lock.json Use emitter, move update check into unique module, implement example of hoped for test 2023-07-30 00:31:01 -07:00
package.json Use emitter, move update check into unique module, implement example of hoped for test 2023-07-30 00:31:01 -07:00
README.md Update readme 2023-08-17 19:23:12 -07:00

README.md

Pulsar Updater

Update utility for Pulsar. On launch of Pulsar, pulsar-updater will check for any new releases available via GitHub APIs. And if one is available will display a notification for the user to be able to install the new version.

If the user seems to have installed Pulsar manually, a link will be opened directly to the resource on GitHub, allowing the user to then download the correct file as needed, and install it. Otherwise if it seems the user has installed Pulsar via various recognized package managers, then Pulsar Updater will present a notification that an update is available, and provide the commands needed to preform the update themselves if they so wish.

This package is made to be minimally invasive, while still allowing users to be aware of new Pulsar versions without any manual effort.

Additionally, since the entire process of actually installation is done by the user, there is no need for complex Squirrel logic, or expensive certifications to allow Squirrel to work.

Command Palette

If a user would prefer to manually check for any updates available then the following commands are exposed from Pulsar Updater to do so:

  • pulsar-updater:check-for-update: Performs an update check and shows a notification if a newer version of Pulsar is available.
  • pulsar-updater:clear-cache: Clears the package's cache and forgets any requests to suppress update checking.

The Update Notification

If an update is available, the notification that is shown is intended to be as non-invasive as possible, providing a few possible options:

  • Dismiss this Version: This will remove the notification, and prevent an additional notification ever appearing for this version again. Bypassing any cache expirations.
  • Dismiss until next launch: This will remove the notification, but only until the next update check. Which happens automatically at launch, or otherwise can be invoked manually.
  • Download from GitHub: This option is only shown if the installation method was determined to be manually. And clicking it will open the GitHub page containing the specific version to update to.

Supported/Checked/Recognized for Installation Methods

Since a major part of the functionality of this package is attempting to determine the installation method, it's important to list them all here:

  • Universal: Developer Mode
  • Universal: Safe Mode
  • Universal: Spec Mode
  • Universal: Developer Instance
  • Windows: Chocolatey Installation
  • Windows: winget Installation
  • Windows: User Installation
  • Windows: Machine Installation
  • Windows: Portable Installation
  • Linux: Flatpak Installation
  • Linux: Deb-Get Installation
  • Linux: Nix Installation
  • Linux: Homebrew Installation
  • Linux: Manual Installation
  • macOS: Homebrew Installation
  • macOS: Manual Installation

Known Issues

It's important to remember that this update system is in no way integrated with the rest of Pulsar. The toggles within Pulsar to update automatically are ignored. The About view will still be unable to alert of new versions, nor track progress on installation. Those systems should eventually be removed, or mothballed, in favour of this.