feat: adds branch parameter (closes #62)

Author: Justintime50

CHANGELOG.md

@@ -3,6 +3,7 @@
 ## Next Release
 
 - Adds `custom_tarball` parameter, allowing you to bundle your distributable assets however you'd like (closes #63)
+- Adds `branch` parameter, allowing you to push the formula file to any branch you'd like (closes #62)
 - Homebrew Releaser now warns instead of raising an exception and exiting with a failure if the `git commit` operation is unsuccessful due to "nothing to commit". This is useful if you want to test back to back releases or need to recreate a release but the underlying assets have not changed (closes #69)
 - Optimizes how asset URL selection occurs when downloading assets to generate checksums for
 - Makes `formula_folder` optional as we always had a default of `Formula`, now allows users to omit its inclusion in their yaml

README.md

@@ -94,6 +94,10 @@ jobs:
           # Default is shown - string
           formula_folder: Formula
 
+          # The branch to push your formula file to (if not used, the branch will be your repo's default branch).
+          # Optional - string
+          branch: bump_foo_to_v2
+
           # The Personal Access Token (saved as a repo secret) that has `repo` permissions for the repo running the action AND Homebrew tap you want to release to.
           # Required - string
           github_token: ${{ secrets.PERSONAL_ACCESS_TOKEN }}

action.yml

@@ -13,6 +13,9 @@ inputs:
   formula_folder:
     description: 'The name of the folder in your homebrew tap where formula will be committed to.'
     required: false
+  branch:
+    description: The branch to push your formula file to (if not present, the branch used will be your repo default branch).
+    required: false
   github_token:
     description: 'The GitHub Token (saved as a repo secret) that has `repo` permissions for the homebrew tap you want to release to.'
     required: true

docker-compose.yml

@@ -7,12 +7,10 @@ services:
     environment:
       # Env vars that should be `false` should be left empty
       - GITHUB_REPOSITORY=justintime50/github-actions-test
-      - INPUT_SKIP_COMMIT=
-      - INPUT_UPDATE_README_TABLE=
-      - INPUT_DEBUG=true
       - INPUT_HOMEBREW_OWNER=justintime50
       - INPUT_HOMEBREW_TAP=homebrew-test
       - INPUT_FORMULA_FOLDER=Formula
+      - INPUT_BRANCH=
       - INPUT_GITHUB_TOKEN=
       - INPUT_COMMIT_OWNER=justintime50
       - INPUT_COMMIT_EMAIL=39606064+Justintime50@users.noreply.github.com
@@ -23,9 +21,13 @@ services:
       - INPUT_CUSTOM_REQUIRE=
       - INPUT_FORMULA_INCLUDES='include Language::Python::Virtualenv'
       - INPUT_UPDATE_PYTHON_RESOURCES=true
+      - INPUT_VERSION=
       - INPUT_TARGET_DARWIN_AMD64=
       - INPUT_TARGET_DARWIN_ARM64=
       - INPUT_TARGET_LINUX_AMD64=
       - INPUT_TARGET_LINUX_ARM64=
       - INPUT_CUSTOM_TARBALL=
+      - INPUT_UPDATE_README_TABLE=
+      - INPUT_SKIP_COMMIT=
       - INPUT_SKIP_CHECKSUM=
+      - INPUT_DEBUG=true

homebrew_releaser/app.py

@@ -9,6 +9,7 @@
     upload_checksum_file,
 )
 from homebrew_releaser.constants import (
+    BRANCH,
     CHECKSUM_FILE,
     COMMIT_EMAIL,
     COMMIT_OWNER,
@@ -228,7 +229,7 @@ def run_github_action():
         logger.info(f"Skipping upload of checksum.txt to {HOMEBREW_TAP}.")
     else:
         logger.info(f"Attempting to release {version} of {GITHUB_REPO} to {HOMEBREW_TAP}...")
-        push_git(HOMEBREW_TAP, HOMEBREW_OWNER)
+        push_git(HOMEBREW_TAP, HOMEBREW_OWNER, BRANCH)
         if SKIP_CHECKSUM:
             logger.info(f"Skipping upload of checksum.txt to {HOMEBREW_TAP}.")
         else:

homebrew_releaser/constants.py

@@ -5,6 +5,7 @@
 HOMEBREW_OWNER = os.getenv("INPUT_HOMEBREW_OWNER", "").lower()
 HOMEBREW_TAP = os.getenv("INPUT_HOMEBREW_TAP", "").lower()
 FORMULA_FOLDER = os.getenv("INPUT_FORMULA_FOLDER", "Formula")
+BRANCH = os.getenv("INPUT_BRANCH")
 GITHUB_TOKEN = os.getenv("INPUT_GITHUB_TOKEN")
 COMMIT_OWNER = os.getenv("INPUT_COMMIT_OWNER", "homebrew-releaser")
 COMMIT_EMAIL = os.getenv("INPUT_COMMIT_EMAIL", "homebrew-releaser@example.com")

homebrew_releaser/git.py

@@ -76,10 +76,13 @@ def commit_git(homebrew_tap: str, repo_name: str, version: str):
             raise
 
 
-def push_git(homebrew_tap: str, homebrew_owner: str):
+def push_git(homebrew_tap: str, homebrew_owner: str, branch: Optional[str] = None):
     """Pushes git assets to the remote Homebrew tap repo."""
     # fmt: off
-    command = ['git', '-C', build_dir_path(homebrew_tap), 'push', f'https://x-access-token:{GITHUB_TOKEN}@github.com/{homebrew_owner}/{homebrew_tap}.git']  # noqa
+    if branch:
+        command = ['git', '-C', build_dir_path(homebrew_tap), 'push', f'https://x-access-token:{GITHUB_TOKEN}@github.com/{homebrew_owner}/{homebrew_tap}.git', f"HEAD:{branch}"]  # noqa
+    else:
+        command = ['git', '-C', build_dir_path(homebrew_tap), 'push', f'https://x-access-token:{GITHUB_TOKEN}@github.com/{homebrew_owner}/{homebrew_tap}.git']  # noqa
     # fmt: on
     _run_git_subprocess(command, f"Assets pushed successfully to {homebrew_tap}.")
 

test/unit/test_git.py

@@ -154,6 +154,31 @@ def test_push(mock_subprocess):
     )
 
 
+@patch("homebrew_releaser.utils.WORKING_DIR", "")
+@patch("homebrew_releaser.git.GITHUB_TOKEN", "123")
+@patch("subprocess.check_output")
+def test_push_with_branch(mock_subprocess):
+    """Tests that we call the correct git push command."""
+    homebrew_tap = "homebrew-formulas"
+    homebrew_owner = "Justintime50"
+
+    push_git(homebrew_tap, homebrew_owner, "test")
+
+    mock_subprocess.assert_called_once_with(
+        [
+            "git",
+            "-C",
+            homebrew_tap,
+            "push",
+            f"https://x-access-token:123@github.com/{homebrew_owner}/{homebrew_tap}.git",
+            "HEAD:test",
+        ],
+        stderr=-2,
+        text=True,
+        timeout=TIMEOUT,
+    )
+
+
 @patch("logging.Logger.debug")
 @patch(
     "subprocess.check_output",