Document jreleaser/jreleaser#1555

jreleaser · Dec 23, 2023 · 29effae · 29effae
1 parent 3220ed4
commit 29effae
Show file tree

Hide file tree

Showing 2 changed files with 61 additions and 0 deletions.
diff --git a/docs/modules/reference/pages/name-templates.adoc b/docs/modules/reference/pages/name-templates.adoc
@@ -1561,6 +1561,8 @@ The following names are related to xref:reference:packagers/homebrew.adoc[].
 | brewDependencies       | a map of key/value pairs
 | brewHashLivecheck      | if custom livecheck instructions were specified
 | brewLivecheck          | a list of strings for the livecheck block
+| brewDownloadStrategy   | custom download strategy
+| brewRequireRelative    | a list of required files, added as `require_relative` statements
 | brewCaskName           | the cask name
 | brewCaskDisplayName    | value for the cask's `desc` field
 | brewCaskHasPkg         | if the cask contains a `.pkg` artifact

diff --git a/docs/modules/reference/pages/packagers/homebrew.adoc b/docs/modules/reference/pages/packagers/homebrew.adoc
@@ -71,6 +71,17 @@ include::partial$packagers/yaml/tap.adoc[]
     # icon:dot-circle[]
     multiPlatform: false
 
+    # Set a custom download strategy. Note that you'll need
+    # to implement the strategy and add it to your tap repository.
+    # Example: https://docs.brew.sh/Formula-Cookbook#url-download-strategies
+    # icon:dot-circle[]
+    downloadStrategy: CurlDownloadStrategy
+
+    # Adds `require_relative` statements at the top of the formula template.
+    # icon:dot-circle[]
+    requireRelative:
+      - custom_download_strategy
+
     # Customize the livecheck block.
     # Default is empty.
     # icon:dot-circle[] icon:file-alt[]
@@ -172,6 +183,16 @@ include::partial$packagers/toml/tap.adoc[]
   # icon:dot-circle[]
   multiPlatform = false
 
+  # Set a custom download strategy. Note that you'll need
+  # to implement the strategy and add it to your tap repository.
+  # Example: https://docs.brew.sh/Formula-Cookbook#url-download-strategies
+  # icon:dot-circle[]
+  downloadStrategy = "CurlDownloadStrategy"
+
+  # Adds `require_relative` statements at the top of the formula template.
+  # icon:dot-circle[]
+  requireRelative = ["custom_download_strategy"]
+
   # Customize the livecheck block.
   # Default is empty.
   # icon:dot-circle[] icon:file-alt[]
@@ -266,6 +287,18 @@ include::partial$packagers/json/tap.adoc[]
       // icon:dot-circle[]
       "multiPlatform": false,
 
+      // Set a custom download strategy. Note that you'll need
+      // to implement the strategy and add it to your tap repository.
+      // Example: https://docs.brew.sh/Formula-Cookbook#url-download-strategies
+      // icon:dot-circle[]
+      "downloadStrategy": "CurlDownloadStrategy",
+
+      // Adds `require_relative` statements at the top of the formula template.
+      // icon:dot-circle[]
+      "requireRelative": [
+        "custom_download_strategy"
+      ],
+
       // Customize the livecheck block.
       // Default is empty.
       // icon:dot-circle[] icon:file-alt[]
@@ -379,6 +412,22 @@ include::partial$packagers/maven/tap.adoc[]
       -->
       <multiPlatform>false</multiPlatform>
 
+      <!--
+        Set a custom download strategy. Note that you'll need
+        to implement the strategy and add it to your tap repository.
+        Example: https://docs.brew.sh/Formula-Cookbook#url-download-strategies
+        icon:dot-circle[]
+      -->
+      <downloadStrategy>CurlDownloadStrategy</downloadStrategy>
+
+      <!--
+        Adds `require_relative` statements at the top of the formula template.
+        icon:dot-circle[]
+      -->
+      <requireRelative>
+        <require>custom_download_strategy</require>
+      </requireRelative>
+
       <!--
         Customize the livecheck block.
         Default is empty.
@@ -516,6 +565,16 @@ include::partial$packagers/gradle/tap.adoc[]
       // icon:dot-circle[]
       multiPlatform = false
 
+      // Set a custom download strategy. Note that you'll need
+      // to implement the strategy and add it to your tap repository.
+      // Example: https://docs.brew.sh/Formula-Cookbook#url-download-strategies
+      // icon:dot-circle[]
+      downloadStrategy = 'CurlDownloadStrategy'
+
+      // Adds `require_relative` statements at the top of the formula template.
+      // icon:dot-circle[]
+      requireRelative = ['custom_download_strategy']
+
       // Customize the livecheck block.
       // Default is empty.
       // icon:dot-circle[] icon:file-alt[]