How to submit?
June 1, 2022 ยท View on GitHub
Please create a YAML file in config/$org/$repo.yml.
Below is an example of it:
filename: "{{.Name}}-{{.OS}}-{{.Arch}}"
binary: kk # please provide a binary file name if the release filename is not the final one
targetBinary: kk # a desired target binary file name
tar: true # if this is a tar file
formatOverrides: # set the file extension for different platforms
windows: zip
linux: tar.gz
replacements: # the replacement of os, arch
amd64: 64bit
darwin: macos
categories:
- storage
- ci
- cd
- k8s
- security
- container
- git
Even you can provide an external resource instead of GitHub release:
url: "https://get.helm.sh/{{.Name}}-{{.Version}}-{{.OS}}-{{.Arch}}.tar.gz"
Variables
| Name | Description |
|---|---|
{{.Name}} | The filename |
{{.OS}} | Could be linux, darwin. It align with runtime.GOOS |
{{.Arch}} | It align with runtime.GOARCH |
{{.Version}} | The version. For example: v1.0.1 |
{{.VersionNum}} | The version without the prefix v. For example: 1.0.1 |
Fields
| Name | Description | Example |
|---|---|---|
fromSource | Indicate if this tool supports to install via go install github.com/xxx/xxx | ks |
tar | Indicate if the release asset is a tarball | kind |
replacements | A map of replacements for the variant of os or arch | ko |
additionBinaries | You can add additional binary files if there are multiple files | containerd |
targetBinary | Give a new binary file name if you don't use the origin one | podman |
binary | The binary file name in the tarball | hd |
latestVersion | Provide a URL for getting the latest version | spin |