-
Notifications
You must be signed in to change notification settings - Fork 15
/
doc.go
30 lines (20 loc) · 1.14 KB
/
doc.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
/*
go-selfupdate detects the information of the latest release via GitHub Releases API and checks the current version.
If newer version than itself is detected, it downloads released binary from GitHub and replaces itself.
- Automatically detects the latest version of released binary on GitHub
- Retrieve the proper binary for the OS and arch where the binary is running
- Update the binary with rollback support on failure
- Tested on Linux, macOS and Windows
- Many archive and compression formats are supported (zip, gzip, xzip, bzip2, tar)
There are some naming rules. Please read following links.
Naming Rules of Released Binaries:
https://github.com/creativeprojects/go-selfupdate#naming-rules-of-released-binaries
Naming Rules of Git Tags:
https://github.com/creativeprojects/go-selfupdate#naming-rules-of-versions-git-tags
This package is hosted on GitHub:
https://github.com/creativeprojects/go-selfupdate
Small CLI tools as wrapper of this library are available also:
https://github.com/creativeprojects/go-selfupdate/cmd/detect-latest-release
https://github.com/creativeprojects/go-selfupdate/cmd/go-get-release
*/
package selfupdate