From 29effae012dc95ace7cab770af30ee6d2645c43d Mon Sep 17 00:00:00 2001 From: Andres Almiray Date: Fri, 15 Dec 2023 17:08:36 -0600 Subject: [PATCH] Document https://github.com/jreleaser/jreleaser/issues/1555 --- .../reference/pages/name-templates.adoc | 2 + .../reference/pages/packagers/homebrew.adoc | 59 +++++++++++++++++++ 2 files changed, 61 insertions(+) diff --git a/docs/modules/reference/pages/name-templates.adoc b/docs/modules/reference/pages/name-templates.adoc index ae8b8e5d4..bdb52be7f 100644 --- 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 index b12b296e4..7ac42a11e 100644 --- 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[] --> false + + CurlDownloadStrategy + + + + custom_download_strategy + +