From d4b570a00271683fa26248212e0a221236f3100c Mon Sep 17 00:00:00 2001 From: Carlos A Becker Date: Sun, 18 Dec 2022 16:49:55 -0300 Subject: [PATCH] fix: clarify scoop no windows archive errors closes #3648 Signed-off-by: Carlos A Becker --- internal/pipe/scoop/scoop.go | 5 +++-- www/docs/errors/scoop-archive.md | 20 ++++++++++++++++++++ www/mkdocs.yml | 1 + 3 files changed, 24 insertions(+), 2 deletions(-) create mode 100644 www/docs/errors/scoop-archive.md diff --git a/internal/pipe/scoop/scoop.go b/internal/pipe/scoop/scoop.go index 79747c06296..5aa9d27d497 100644 --- a/internal/pipe/scoop/scoop.go +++ b/internal/pipe/scoop/scoop.go @@ -21,8 +21,9 @@ import ( "github.com/goreleaser/goreleaser/pkg/context" ) -// ErrNoWindows when there is no build for windows (goos doesn't contain windows). -var ErrNoWindows = errors.New("scoop requires a windows build and archive") +// ErrNoWindows when there is no build for windows (goos doesn't contain +// windows) or archive.format is binary. +var ErrNoWindows = errors.New("scoop requires a windows archive\nLearn more at https://goreleaser.com/errors/scoop-archive\n") const scoopConfigExtra = "ScoopConfig" diff --git a/www/docs/errors/scoop-archive.md b/www/docs/errors/scoop-archive.md new file mode 100644 index 00000000000..d456898ec32 --- /dev/null +++ b/www/docs/errors/scoop-archive.md @@ -0,0 +1,20 @@ +# Scoop requires a windows archive + +The Scoop pipe requires a Windows build and archive. + +The archive should not be in `binary` format. + +For instance, this won't work: + +```yaml +archives: +- format: binary +``` + + +But this would: + +```yaml +archives: +- format: zip +``` diff --git a/www/mkdocs.yml b/www/mkdocs.yml index c879dcc4837..5354342c010 100644 --- a/www/mkdocs.yml +++ b/www/mkdocs.yml @@ -155,6 +155,7 @@ nav: - errors/resource-not-accessible-by-integration.md - errors/no-history.md - errors/multiple-binaries-archive.md + - errors/scoop-archive.md - deprecations.md - Cookbooks: - About: cookbooks/index.md