This repository has been archived by the owner on Jan 8, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 21
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
1 addition
and
51 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,53 +1,3 @@ | ||
| # Updater | ||
|
|
||
| [](https://github.com/keybase/go-updater/actions) | ||
| [](https://godoc.org/github.com/keybase/go-updater) | ||
|
|
||
| **Warning**: This isn't ready for non-Keybase libraries to use yet! | ||
|
|
||
| The goals of this library are to provide an updater that: | ||
|
|
||
| - Is simple | ||
| - Works on all our platforms (at least OS X, Windows, Linux) | ||
| - Recovers from non-fatal errors | ||
| - Every request or command execution should timeout (nothing blocks) | ||
| - Can recover from failures in its environment | ||
| - Can run as an unprivileged background service | ||
| - Has minimal, vendored dependencies | ||
| - Is well tested | ||
| - Is secure | ||
| - Reports failures and activity | ||
| - Can notify the user of any non-transient failures | ||
|
|
||
| This updater library is used to support updating (in background and on-demand) | ||
| for Keybase apps and services. | ||
|
|
||
| ### Packages | ||
|
|
||
| The main package is the updater core, there are other support packages: | ||
|
|
||
| - command: Executes a command with a timeout | ||
| - keybase: Keybase specific behavior for updates | ||
| - osx: MacOS specific UI | ||
| - process: Utilities to find and terminate Processes | ||
| - saltpack: Verify updates with [saltpack](https://saltpack.org/) | ||
| - service: Runs the updater as a background service | ||
| - sources: Update sources for remote locations (like S3), or locally (for testing) | ||
| - test: Test resources | ||
| - util: Utilities for updating, such as digests, env, file, http, unzip, etc. | ||
| - watchdog: Utility to monitor processes and restart them (like launchd), for use with updater service | ||
| - windows: Windows specific UI | ||
|
|
||
| ### Development | ||
|
|
||
| This library should pass the [gometalinter](https://github.com/alecthomas/gometalinter). | ||
|
|
||
| There is a pre-commit hook available: | ||
|
|
||
| ``` | ||
| pip install pre-commit | ||
| go get -u github.com/alecthomas/gometalinter | ||
| gometalinter --install --update | ||
| pre-commit install | ||
| pre-commit run -a | ||
| ``` | ||
| Moved -> https://github.com/keybase/client/tree/master/go/updater. |