Medzik
/
go-github-selfupdate
mirror of https://github.com/MedzikUser/go-github-selfupdate.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

revise README

This commit is contained in:
rhysd 2017-12-30 11:45:47 +09:00
parent f44b3ad7b4
commit 08f51f54ab
1 changed files with 96 additions and 31 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

127
README.md
View File

@ -3,97 +3,153 @@ Self-Update Mechanism for Go Commands using GitHub
[go-github-selfupdate][] is a Go library to provide self-update mechanism to command line tools.
Go does not provide the way to install/update the specific version of tools. By default, Go command line tools are updated
Go does not provide the way to install/update the stable version of tools. By default, Go command line tools are updated
- using `go get -u` (updating to HEAD)
- using system's package manager (depending on the platform)
- downloading executables from GitHub release page
- downloading executables from GitHub release page manually
By using this library, you will get 4th choice:
- from your command line tool directly
- from your command line tool directly (and automatically)
go-github-selfupdate retrieves the information of released binaries via [GitHub Releases API][] and check the current version. If newer version than itself is detected, it updates binary by downloading from GitHub and replacing itself.
go-github-selfupdate detects the information of the latest release via [GitHub Releases API][] and check the current version.
If newer version than itself is detected, it downloads released binary from GitHub and replaces itself.
Please note that this library assumes you adopt [semantic versioning][]. It is necessary for comparing versions systematically.
- 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, tar)
[go-github-selfupdate]: https://github.com/rhysd/go-github-selfupdate
[semantic versioning]: https://semver.org/
[GitHub Releases API]: https://developer.github.com/v3/repos/releases/
## Try Out Example
TODO
## Usage
### Code
### Code Usage
It provides `selfupdate` package.
Following is the easiest way to use this package.
```go
import (
"log"
"github.com/blang/semver"
"github.com/rhysd/go-github-selfupdate/selfupdate"
)
func doUpdate(version string) {
up, err := selfupdate.TryUpdate(version, "myname/myrepo", nil)
const version = "1.2.3"
func doSelfUpdate() {
v := semver.MustParse(version)
latest, err := selfupdate.UpdateSelf(v, "myname/myrepo")
if err != nil {
log.Println("Binary update failed", err)
log.Println("Binary update failed:", err)
return
}
if up.Version == version {
if latest.Version.Equals(v) {
// latest version is the same as current version. It means current binary is up to date.
log.Println("Current binary is the latest version", version)
} else {
log.Println("Update successfully done to version", up.Version)
log.Println("Successfully updated to version", latest.Version)
}
}
```
- `selfupdate.TryUpdate()`
- `selfupdate.TryUpdateTo()`
- `selfupdate.DetectLatest()`
- `selfupdate.UpdateSelf()`: Detect the latest version of itself and run self update.
- `selfupdate.UpdateCommand()`: Detect the latest version of given repository and update given command.
- `selfupdate.DetectLatest()`: Detect the latest version of given repository.
- `selfupdate.UpdateTo()`: Update given command to the binary hosted on given URL.
Please see [the documentation page][GoDoc] for more detail.
[GoDoc]: https://godoc.org/github.com/rhysd/go-github-selfupdate
### Naming Rules of Released Binaries
go-github-selfupdate assumes that released binaries are put for each combination of platforms and archs.
Binaries for each platform can be easily built using tools like [gox][]
For example, if your command name is `foo-bar`, one of followings is expected to be put in release page on GitHub as binary for platform `linux` and arch `amd64`.
You need to put the binaries with the following format.
```
{cmd}_{goos}_{goarch}{.ext}
```
`{cmd}` is a name of command.
`{goos}` and `{goarch}` are the platform and the arch type of the binary.
`{.ext}` is a file extension. go-github-selfupdate supports `.zip`, `.gzip` and `.tar.gz`.
You can also use blank and it means binary is not compressed.
If you compress binary, uncompressed directory or file must contain the executable named `{cmd}`.
And you can also use `-` for separator instead of `_` if you like.
For example, if your command name is `foo-bar`, one of followings is expected to be put in release
page on GitHub as binary for platform `linux` and arch `amd64`.
- `foo-bar-linux-amd64` (executable)
- `foo-bar-linux-amd64.zip` (zip file)
- `foo-bar-linux-amd64.tar.gz` (gzip file)
- `foo-bar_linux_amd64` (executable)
- `foo-bar_linux_amd64.zip` (zip file)
- `foo-bar_linux_amd64.tar.gz` (gzip file)
- `foo-bar_linux_amd64.zip` (zip file containing `foo-bar`)
- `foo-bar_linux_amd64.tar.gz` (tar file containing `foo-bar`)
- `foo-bar_linux_amd64.gzip` (gzip file of the executable `foo-bar`)
- `foo-bar-linux-amd64.tar.gz` (`-` is also ok for separator)
### Naming Rules of Git Tags
[gox]: https://github.com/mitchellh/gox
go-github-selfupdate searches binaries' versions via corresponding Git tag names. When your binary's version is `1.2.3`, you should use `1.2.3` or `v1.2.3` (prefixed with `v`) as Git tag name.
### Naming Rules of Versions (=Git Tags)
go-github-selfupdate searches binaries' versions via Git tag names (not a release title).
When your tool's version is `1.2.3`, you should use the version number for tag of the Git
repository (i.e. `1.2.3` or `v1.2.3`).
This library assumes you adopt [semantic versioning][]. It is necessary for comparing versions
systematically.
Prefix before version number `\d+\.\d+\.\d+` is automatically omitted. For example, `ver1.2.3` or
`release-1.2.3` are also ok.
Tags which don't contain a version number are ignored (i.e. `nightly`). And releases marked as `pre-release`
are also ignored.
### Structure of Releases
In summary, structure of releases on GitHub looks like:
- `v1.2.0`
- `foo-bar-linux-amd64.zip`
- `foo-bar-linux-386.zip`
- `foo-bar-darwin-amd64.zip`
- `foo-bar-linux-amd64.tar.gz`
- `foo-bar-linux-386.tar.gz`
- `foo-bar-darwin-amd64.tar.gz`
- `foo-bar-windows-amd64.zip`
- ... (Other binaries for v1.2.0)
- `v1.1.3`
- `foo-bar-linux-amd64.zip`
- `foo-bar-linux-386.zip`
- `foo-bar-darwin-amd64.zip`
- `foo-bar-linux-amd64.tar.gz`
- `foo-bar-linux-386.tar.gz`
- `foo-bar-darwin-amd64.tar.gz`
- `foo-bar-windows-amd64.zip`
- ... (Other binaries for v1.1.3)
- ... (older versions)
Tags which don't contain a version number are ignored (i.e. `nightly`). And releases marked as `pre-release` are also ignored.
### Debugging
This library can output logs for debugging. By default, logger is disabled.
You can enable the logger by following and can know the details of the self update.
```go
selfupdate.EnableLog()
```
## Dependencies
This library utilizes [go-github][] to retrieve the information of releases and [go-update][] to replace current binary and [semver][] to compare versions.
This library utilizes [go-github][] to retrieve the information of releases and [go-update][] to replace
current binary and [semver][] to compare versions.
> Copyright (c) 2013 The go-github AUTHORS. All rights reserved.
@ -104,3 +160,12 @@ This library utilizes [go-github][] to retrieve the information of releases and
[go-github]: https://github.com/google/go-github
[go-update]: https://github.com/inconshreveable/go-update
[semver]: https://github.com/blang/semver
## What is the different from [tj/go-update][]?
TODO
[tj/go-udpate]: https://github.com/tj/go-update
[GoDoc]: https://godoc.org/github.com/rhysd/go-github-selfupdate