mirror of
https://github.com/goreleaser/goreleaser.git
synced 2025-01-10 03:47:03 +02:00
53bbc6546f
It was just allowing v2 and v3 due to some misreading on my side. This commit fixes it to allow v1, v2, v3 and v4. refs #3016 Signed-off-by: Carlos A Becker <caarlos0@gmail.com>
117 lines
3.8 KiB
Markdown
117 lines
3.8 KiB
Markdown
# Scoop Manifests
|
|
|
|
After releasing to GitHub or GitLab, GoReleaser can generate and publish a
|
|
_Scoop App Manifest_ into a repository that you have access to.
|
|
|
|
The `scoop` section specifies how the manifest should be created. See
|
|
the commented example below:
|
|
|
|
```yaml
|
|
# .goreleaser.yaml
|
|
scoop:
|
|
# Template for the url which is determined by the given Token (github or gitlab)
|
|
# Default for github is "https://github.com/<repo_owner>/<repo_name>/releases/download/{{ .Tag }}/{{ .ArtifactName }}"
|
|
# Default for gitlab is "https://gitlab.com/<repo_owner>/<repo_name>/-/releases/{{ .Tag }}/downloads/{{ .ArtifactName }}"
|
|
# Default for gitea is "https://gitea.com/<repo_owner>/<repo_name>/releases/download/{{ .Tag }}/{{ .ArtifactName }}"
|
|
url_template: "http://github.mycompany.com/foo/bar/releases/{{ .Tag }}/{{ .ArtifactName }}"
|
|
|
|
# Repository to push the app manifest to.
|
|
bucket:
|
|
owner: user
|
|
name: scoop-bucket
|
|
|
|
# Optionally a branch can be provided.
|
|
# Defaults to the default repository branch.
|
|
branch: main
|
|
|
|
# Optionally a token can be provided, if it differs from the token provided to GoReleaser
|
|
token: "{{ .Env.HOMEBREW_TAP_GITHUB_TOKEN }}"
|
|
|
|
# Folder inside the repository to put the scoop.
|
|
# Default is the root folder.
|
|
folder: Scoops
|
|
|
|
# Git author used to commit to the repository.
|
|
# Defaults are shown.
|
|
commit_author:
|
|
name: goreleaserbot
|
|
email: goreleaser@carlosbecker.com
|
|
|
|
# The project name and current git tag are used in the format string.
|
|
commit_msg_template: "Scoop update for {{ .ProjectName }} version {{ .Tag }}"
|
|
|
|
# Your app's homepage.
|
|
# Default is empty.
|
|
homepage: "https://example.com/"
|
|
|
|
# Your app's description.
|
|
# Default is empty.
|
|
description: "Software to create fast and easy drum rolls."
|
|
|
|
# Your app's license
|
|
# Default is empty.
|
|
license: MIT
|
|
|
|
# Setting this will prevent goreleaser to actually try to commit the updated
|
|
# manifest leaving the responsibility of publishing it to the user.
|
|
# If set to auto, the release will not be uploaded to the scoop bucket
|
|
# in case there is an indicator for prerelease in the tag e.g. v1.0.0-rc1
|
|
# Default is false.
|
|
skip_upload: true
|
|
|
|
# Persist data between application updates
|
|
persist:
|
|
- "data"
|
|
- "config.toml"
|
|
|
|
# An array of commands to be executed before an application is installed.
|
|
# Default is empty.
|
|
pre_install: ["Write-Host 'Running preinstall command'"]
|
|
|
|
# An array of commands to be executed after an application is installed.
|
|
# Default is empty.
|
|
post_install: ["Write-Host 'Running postinstall command'"]
|
|
|
|
# GOAMD64 to specify which amd64 version to use if there are multiple versions
|
|
# from the build section.
|
|
# Default is v1.
|
|
goamd64: v3
|
|
```
|
|
|
|
By defining the `scoop` section, GoReleaser will take care of publishing the
|
|
Scoop app. Assuming that the project name is `drumroll` and the current tag is
|
|
`v1.2.3`, the above configuration will generate a `drumroll.json` manifest in
|
|
the root of the repository specified in the `bucket` section.
|
|
|
|
```json
|
|
{
|
|
"version": "1.2.3",
|
|
"architecture": {
|
|
"64bit": {
|
|
"url":
|
|
"https://github.com/user/drumroll/releases/download/1.2.3/drumroll_1.2.3_windows_amd64.tar.gz",
|
|
"bin": "drumroll.exe",
|
|
"hash": "86920b1f04173ee08773136df31305c0dae2c9927248ac259e02aafd92b6008a"
|
|
},
|
|
"32bit": {
|
|
"url":
|
|
"https://github.com/user/drumroll/releases/download/1.2.3/drumroll_1.2.3_windows_386.tar.gz",
|
|
"bin": "drumroll.exe",
|
|
"hash": "283faa524ef41987e51c8786c61bb56658a489f63512b32139d222b3ee1d18e6"
|
|
}
|
|
},
|
|
"homepage": "https://example.com/"
|
|
}
|
|
```
|
|
|
|
Your users can then install your app by doing:
|
|
|
|
```sh
|
|
scoop bucket add org https://github.com/org/repo.git
|
|
scoop install org/drumroll
|
|
```
|
|
|
|
You can check the
|
|
[Scoop documentation](https://github.com/lukesampson/scoop/wiki) for more
|
|
details.
|