fix: clarify scoop no windows archive errors

closes #3648 Signed-off-by: Carlos A Becker <caarlos0@users.noreply.github.com>
goreleaser · Dec 18, 2022 · d4b570a · d4b570a
1 parent d7ce484
commit d4b570a
Show file tree

Hide file tree

Showing 3 changed files with 24 additions and 2 deletions.
diff --git 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
@@ -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
@@ -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