Patrice Ferlet
c7c18f01cd
- better gomarkdown generation that now fixed the escaped strings, no need to use pandoc anymore - added workflow image - upgraded versions of mkdocs requirements
61 lines
1.4 KiB
Markdown
61 lines
1.4 KiB
Markdown
<!-- Code generated by gomarkdoc. DO NOT EDIT -->
|
|
|
|
# update
|
|
|
|
```go
|
|
import "katenary/update"
|
|
```
|
|
|
|
Update package is used to check if a new version of katenary is available.
|
|
|
|
## Variables
|
|
|
|
<a name="Version"></a>
|
|
|
|
```go
|
|
var (
|
|
Version = "master" // reset by cmd/main.go
|
|
)
|
|
```
|
|
|
|
<a name="DownloadFile"></a>
|
|
## func [DownloadFile](<https://github.com/metal3d/katenary/blob/develop/update/main.go#L134>)
|
|
|
|
```go
|
|
func DownloadFile(url, exe string) error
|
|
```
|
|
|
|
DownloadFile will download a url to a local file. It also ensure that the file is executable.
|
|
|
|
<a name="DownloadLatestVersion"></a>
|
|
## func [DownloadLatestVersion](<https://github.com/metal3d/katenary/blob/develop/update/main.go#L80>)
|
|
|
|
```go
|
|
func DownloadLatestVersion(assets []Asset) error
|
|
```
|
|
|
|
DownloadLatestVersion will download the latest version of katenary.
|
|
|
|
<a name="Asset"></a>
|
|
## type [Asset](<https://github.com/metal3d/katenary/blob/develop/update/main.go#L23-L26>)
|
|
|
|
Asset is a github asset from release url.
|
|
|
|
```go
|
|
type Asset struct {
|
|
Name string `json:"name"`
|
|
URL string `json:"browser_download_url"`
|
|
}
|
|
```
|
|
|
|
<a name="CheckLatestVersion"></a>
|
|
### func [CheckLatestVersion](<https://github.com/metal3d/katenary/blob/develop/update/main.go#L29>)
|
|
|
|
```go
|
|
func CheckLatestVersion() (string, []Asset, error)
|
|
```
|
|
|
|
CheckLatestVersion check katenary latest version from release and propose to download it
|
|
|
|
Generated by [gomarkdoc](<https://github.com/princjef/gomarkdoc>)
|