mirror of
https://github.com/goreleaser/goreleaser.git
synced 2025-02-03 13:11:48 +02:00
62b065dad0
It should make goreleaser easier to use, as a `repository` is now always called `repository`. Signed-off-by: Carlos Alexandro Becker <caarlos0@users.noreply.github.com>
136 lines
4.4 KiB
Markdown
136 lines
4.4 KiB
Markdown
# Scoop Manifests
|
|
|
|
After releasing to GitHub, GitLab, or Gitea, 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
|
|
# Since: v1.18
|
|
scoops:
|
|
- # Name of the recipe
|
|
#
|
|
# Default: ProjectName
|
|
# Templates: allowed (since v1.19)
|
|
name: myproject
|
|
|
|
# URL which is determined by the given Token (github or gitlab)
|
|
#
|
|
# Default:
|
|
# GitHub: 'https://github.com/<repo_owner>/<repo_name>/releases/download/{{ .Tag }}/{{ .ArtifactName }}'
|
|
# GitLab: 'https://gitlab.com/<repo_owner>/<repo_name>/-/releases/{{ .Tag }}/downloads/{{ .ArtifactName }}'
|
|
# Gitea: 'https://gitea.com/<repo_owner>/<repo_name>/releases/download/{{ .Tag }}/{{ .ArtifactName }}'
|
|
# Templates: allowed
|
|
url_template: "http://github.mycompany.com/foo/bar/releases/{{ .Tag }}/{{ .ArtifactName }}"
|
|
|
|
# Folder inside the repository to put the scoop.
|
|
#
|
|
# Note that while scoop works if the manifests are in a folder,
|
|
# 'scoop bucket list' will show 0 manifests if they are not in the root
|
|
# folder.
|
|
# In short, it's generally better to leave this empty.
|
|
folder: Scoops
|
|
|
|
# Git author used to commit to the repository.
|
|
commit_author:
|
|
name: goreleaserbot
|
|
email: bot@goreleaser.com
|
|
|
|
# The project name and current git tag are used in the format string.
|
|
#
|
|
# Templates: allowed
|
|
commit_msg_template: "Scoop update for {{ .ProjectName }} version {{ .Tag }}"
|
|
|
|
# Your app's homepage.
|
|
#
|
|
# Templates: allowed (since v1.19)
|
|
homepage: "https://example.com/"
|
|
|
|
# Your app's description.
|
|
#
|
|
# Templates: allowed (since v1.19)
|
|
description: "Software to create fast and easy drum rolls."
|
|
|
|
# Your app's license
|
|
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
|
|
#
|
|
# Templates: allowed (since v1.19)
|
|
skip_upload: true
|
|
|
|
# Persist data between application updates
|
|
persist:
|
|
- "data"
|
|
- "config.toml"
|
|
|
|
# An array of commands to be executed before an application is installed.
|
|
pre_install: ["Write-Host 'Running preinstall command'"]
|
|
|
|
# An array of commands to be executed after an application is installed.
|
|
post_install: ["Write-Host 'Running postinstall command'"]
|
|
|
|
# An array of dependencies.
|
|
#
|
|
# Since GoReleaser v1.16
|
|
depends: ["git", "foo"]
|
|
|
|
# A two-dimensional array of string, specifies the shortcut values to make available in the startmenu.
|
|
# The array has to contain an executable/label pair. The third and fourth element are optional.
|
|
#
|
|
# Since GoReleaser v1.17.0.
|
|
shortcuts: [["drumroll.exe", "drumroll"]]
|
|
|
|
# GOAMD64 to specify which amd64 version to use if there are multiple versions
|
|
# from the build section.
|
|
#
|
|
# Default: 'v1'
|
|
goamd64: v3
|
|
|
|
{% include-markdown "../includes/repository.md" comments=false %}
|
|
```
|
|
|
|
!!! tip
|
|
|
|
Learn more about the [name template engine](/customization/templates/).
|
|
|
|
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.
|