feat(homebrew): add os to dependency (#4481)

closes #4480
goreleaser · Dec 15, 2023 · ee14837 · ee14837
1 parent e39548d
commit ee14837
Show file tree

Hide file tree

Showing 13 changed files with 32 additions and 0 deletions.
diff --git a/internal/pipe/brew/brew_test.go b/internal/pipe/brew/brew_test.go
@@ -313,6 +313,8 @@ func TestFullPipe(t *testing.T) {
 								{Name: "zsh", Type: "optional"},
 								{Name: "bash", Version: "3.2.57"},
 								{Name: "fish", Type: "optional", Version: "v1.2.3"},
+								{Name: "powershell", Type: "optional", OS: "mac"},
+								{Name: "ash", Version: "1.0.0", OS: "linux"},
 							},
 							Conflicts:   []string{"gtk+", "qt"},
 							Service:     "run foo/bar\nkeep_alive true",

diff --git a/internal/pipe/brew/template.go b/internal/pipe/brew/template.go
@@ -49,6 +49,7 @@ class {{ .Name }} < Formula
   {{ range $index, $element := . }}
   depends_on "{{ .Name }}"
   {{- if .Type }} => :{{ .Type }}{{- else if .Version }} => "{{ .Version }}"{{- end }}
+  {{- with .OS }} if OS.{{ . }}?{{- end }}
   {{- end }}
   {{- end -}}
 

diff --git a/internal/pipe/brew/testdata/TestFullPipe/custom_block.rb.golden b/internal/pipe/brew/testdata/TestFullPipe/custom_block.rb.golden
@@ -7,8 +7,10 @@ class CustomBlock < Formula
   homepage "https://github.com/goreleaser"
   version "1.0.1"
 
+  depends_on "ash" => "1.0.0" if OS.linux?
   depends_on "bash" => "3.2.57"
   depends_on "fish" => :optional
+  depends_on "powershell" => :optional if OS.mac?
   depends_on "zsh" => :optional
 
   on_macos do

diff --git a/internal/pipe/brew/testdata/TestFullPipe/custom_download_strategy.rb.golden b/internal/pipe/brew/testdata/TestFullPipe/custom_download_strategy.rb.golden
@@ -7,8 +7,10 @@ class CustomDownloadStrategy < Formula
   homepage "https://github.com/goreleaser"
   version "1.0.1"
 
+  depends_on "ash" => "1.0.0" if OS.linux?
   depends_on "bash" => "3.2.57"
   depends_on "fish" => :optional
+  depends_on "powershell" => :optional if OS.mac?
   depends_on "zsh" => :optional
 
   on_macos do

diff --git a/internal/pipe/brew/testdata/TestFullPipe/custom_require.rb.golden b/internal/pipe/brew/testdata/TestFullPipe/custom_require.rb.golden
@@ -8,8 +8,10 @@ class CustomRequire < Formula
   homepage "https://github.com/goreleaser"
   version "1.0.1"
 
+  depends_on "ash" => "1.0.0" if OS.linux?
   depends_on "bash" => "3.2.57"
   depends_on "fish" => :optional
+  depends_on "powershell" => :optional if OS.mac?
   depends_on "zsh" => :optional
 
   on_macos do

diff --git a/internal/pipe/brew/testdata/TestFullPipe/default.rb.golden b/internal/pipe/brew/testdata/TestFullPipe/default.rb.golden
@@ -7,8 +7,10 @@ class Default < Formula
   homepage "https://github.com/goreleaser"
   version "1.0.1"
 
+  depends_on "ash" => "1.0.0" if OS.linux?
   depends_on "bash" => "3.2.57"
   depends_on "fish" => :optional
+  depends_on "powershell" => :optional if OS.mac?
   depends_on "zsh" => :optional
 
   on_macos do

diff --git a/internal/pipe/brew/testdata/TestFullPipe/default_gitlab.rb.golden b/internal/pipe/brew/testdata/TestFullPipe/default_gitlab.rb.golden
@@ -7,8 +7,10 @@ class DefaultGitlab < Formula
   homepage "https://gitlab.com/goreleaser"
   version "1.0.1"
 
+  depends_on "ash" => "1.0.0" if OS.linux?
   depends_on "bash" => "3.2.57"
   depends_on "fish" => :optional
+  depends_on "powershell" => :optional if OS.mac?
   depends_on "zsh" => :optional
 
   on_macos do

diff --git a/internal/pipe/brew/testdata/TestFullPipe/git_remote.rb.golden b/internal/pipe/brew/testdata/TestFullPipe/git_remote.rb.golden
@@ -7,8 +7,10 @@ class GitRemote < Formula
   homepage "https://github.com/goreleaser"
   version "1.0.1"
 
+  depends_on "ash" => "1.0.0" if OS.linux?
   depends_on "bash" => "3.2.57"
   depends_on "fish" => :optional
+  depends_on "powershell" => :optional if OS.mac?
   depends_on "zsh" => :optional
 
   on_macos do

diff --git a/internal/pipe/brew/testdata/TestFullPipe/open_pr.rb.golden b/internal/pipe/brew/testdata/TestFullPipe/open_pr.rb.golden
@@ -7,8 +7,10 @@ class OpenPr < Formula
   homepage "https://github.com/goreleaser"
   version "1.0.1"
 
+  depends_on "ash" => "1.0.0" if OS.linux?
   depends_on "bash" => "3.2.57"
   depends_on "fish" => :optional
+  depends_on "powershell" => :optional if OS.mac?
   depends_on "zsh" => :optional
 
   on_macos do

diff --git a/internal/pipe/brew/testdata/TestFullPipe/valid_repository_templates.rb.golden b/internal/pipe/brew/testdata/TestFullPipe/valid_repository_templates.rb.golden
@@ -7,8 +7,10 @@ class ValidRepositoryTemplates < Formula
   homepage ""
   version "1.0.1"
 
+  depends_on "ash" => "1.0.0" if OS.linux?
   depends_on "bash" => "3.2.57"
   depends_on "fish" => :optional
+  depends_on "powershell" => :optional if OS.mac?
   depends_on "zsh" => :optional
 
   on_macos do

diff --git a/pkg/config/config.go b/pkg/config/config.go
@@ -156,6 +156,7 @@ type HomebrewDependency struct {
 	Name    string `yaml:"name,omitempty" json:"name,omitempty"`
 	Type    string `yaml:"type,omitempty" json:"type,omitempty"`
 	Version string `yaml:"version,omitempty" json:"version,omitempty"`
+	OS      string `yaml:"os,omitempty" json:"os,omitempty" jsonschema:"enum=mac,enum=linux"`
 }
 
 // type alias to prevent stack overflowing in the custom unmarshaler.

diff --git a/www/docs/customization/homebrew.md b/www/docs/customization/homebrew.md
@@ -115,6 +115,11 @@ brews:
     # Packages your package depends on.
     dependencies:
       - name: git
+        # Allow to specify the OS in which the dependency is required.
+        # Valid options are `mac` and `linux`.
+        #
+        # Since: v1.23.0
+        os: mac
       - name: zsh
         type: optional
       - name: fish

diff --git a/www/docs/static/schema.json b/www/docs/static/schema.json