feat: add Homebrew tap support

Author: gnugat

CONTRIBUTING.md

@@ -3,7 +3,7 @@
 Everybody should be able to help. Here's how you can make this project more
 awesome:
 
- 1. [Fork the repository](https://github.com/ssc/dtk/fork_select);
+ 1. [Fork the repository](https://github.com/ssc-php/dtk/fork_select);
  2. create your own branch from `main`: `git checkout -b <ticket-id>/<ticket-title>` (or `<type>/<title>` if you have no ticket);
  3. make your changes and don't forget to:
     * check that the tests pass;
@@ -120,7 +120,7 @@ Types are the same as for branch naming.
 Track the upstream (original) repository:
 
 ```console
-git remote add upstream https://github.com/ssc/dtk.git
+git remote add upstream https://github.com/ssc-php/dtk.git
 ```
 
 Then, before publishing your changes, get the upstream changes:

README.md

@@ -42,7 +42,22 @@ All commands are configurable to fit any workflow, with support for:
 
 ## Getting started
 
-Download the binary for your platform from the [releases page](https://github.com/ssc/dtk/releases):
+### Homebrew (macOS and Linux)
+
+```console
+brew tap ssc-php/dtk
+brew install dtk
+```
+
+To upgrade:
+
+```console
+brew upgrade dtk
+```
+
+### Manual install
+
+Download the binary for your platform from the [releases page](https://github.com/ssc-php/dtk/releases):
 
 | Platform       | Binary                   | Examples                                |
 |----------------|--------------------------|-----------------------------------------|
@@ -55,15 +70,15 @@ Download the binary for your platform from the [releases page](https://github.co
 <summary>**🐧 On Linux:**</summary>
 
 ```console
-curl --proto '=https' --tlsv1.2 -fsSL "https://github.com/ssc/dtk/releases/latest/download/dtk-linux-x86_64" -o /tmp/dtk
+curl --proto '=https' --tlsv1.2 -fsSL "https://github.com/ssc-php/dtk/releases/latest/download/dtk-linux-x86_64" -o /tmp/dtk
 
 install -m 755 -D /tmp/dtk ~/.local/bin/dtk
 ```
 
 Verify the checksum:
 
 ```console
-curl --proto '=https' --tlsv1.2 -fsSL "https://github.com/ssc/dtk/releases/latest/download/checksums.txt" \
+curl --proto '=https' --tlsv1.2 -fsSL "https://github.com/ssc-php/dtk/releases/latest/download/checksums.txt" \
   | grep "dtk-linux-x86_64" | awk '{print $1 "  /tmp/dtk"}' | sha256sum --check
 ```
 
@@ -75,15 +90,15 @@ curl --proto '=https' --tlsv1.2 -fsSL "https://github.com/ssc/dtk/releases/lates
 <summary>**🍎 On macOS:**</summary>
 
 ```console
-curl --proto '=https' --tlsv1.2 -fsSL "https://github.com/ssc/dtk/releases/latest/download/dtk-macos-aarch64" -o /tmp/dtk
+curl --proto '=https' --tlsv1.2 -fsSL "https://github.com/ssc-php/dtk/releases/latest/download/dtk-macos-aarch64" -o /tmp/dtk
 
 install -m 755 /tmp/dtk ~/.local/bin/dtk
 ```
 
 Verify the checksum:
 
 ```console
-curl --proto '=https' --tlsv1.2 -fsSL "https://github.com/ssc/dtk/releases/latest/download/checksums.txt" \
+curl --proto '=https' --tlsv1.2 -fsSL "https://github.com/ssc-php/dtk/releases/latest/download/checksums.txt" \
   | grep "dtk-macos-aarch64" | awk '{print $1 "  /tmp/dtk"}' | shasum -a 256 --check
 ```
 
@@ -97,14 +112,14 @@ curl --proto '=https' --tlsv1.2 -fsSL "https://github.com/ssc/dtk/releases/lates
 
 ```powershell
 New-Item -ItemType Directory -Force -Path "$env:USERPROFILE\.local\bin" | Out-Null
-Invoke-WebRequest -Uri "https://github.com/ssc/dtk/releases/latest/download/dtk-windows-x86_64.exe" -OutFile "$env:TEMP\dtk.exe"
+Invoke-WebRequest -Uri "https://github.com/ssc-php/dtk/releases/latest/download/dtk-windows-x86_64.exe" -OutFile "$env:TEMP\dtk.exe"
 ```
 
 Verify the checksum:
 
 ```powershell
 $hash = (Get-FileHash "$env:TEMP\dtk.exe" -Algorithm SHA256).Hash.ToLower()
-$expected = (Invoke-WebRequest -Uri "https://github.com/ssc/dtk/releases/latest/download/checksums.txt").Content -split '\r?\n' |
+$expected = (Invoke-WebRequest -Uri "https://github.com/ssc-php/dtk/releases/latest/download/checksums.txt").Content -split '\r?\n' |
   Where-Object { $_ -match "dtk-windows-x86_64.exe" } | ForEach-Object { ($_ -split '\s+')[0] }
 if ($hash -ne $expected) { throw "Checksum mismatch" }
 ```
@@ -144,7 +159,7 @@ Further documentation can be found in:
 You can see the current and past versions using one of the following:
 
 * the `git tag` command
-* the [releases page on Github](https://github.com/ssc/dtk/releases)
+* the [releases page on Github](https://github.com/ssc-php/dtk/releases)
 * the file listing the [changes between versions](CHANGELOG.md)
 
 And finally some meta documentation:

bin/mk-brew-formula.sh

@@ -0,0 +1,101 @@
+#!/usr/bin/env bash
+set -euo pipefail
+# File: bin/mk-brew-formula.sh
+# ──────────────────────────────────────────────────────────────────────────────
+# Updates the Homebrew formula in ../homebrew-dtk with the current version and
+# checksums from build/checksums.txt, then commits and pushes to the tap repo.
+#
+# Requires ../homebrew-dtk to be a clone of ssc-php/homebrew-dtk.
+#
+# Running order:
+# 1. bump/dtk.sh
+# 2. mk-dtk-bin.sh
+# 3. mk-changelog.sh
+# 4. review and tweak CHANGELOG.md
+# 5. mk-release.sh  (calls this script automatically)
+#
+# Usage:
+#
+# ```shell
+# bin/mk-brew-formula.sh
+# ```
+# ──────────────────────────────────────────────────────────────────────────────
+
+_BIN_DIR="$(cd "$(dirname "${BASH_SOURCE[0]:-$0}")" && pwd)"
+cd "${_BIN_DIR}/.."
+
+_TAP_DIR="${_BIN_DIR}/../../homebrew-dtk"
+
+if [[ ! -d "${_TAP_DIR}/.git" ]]; then
+    echo "Error: ${_TAP_DIR} is not a git repository" >&2
+    exit 1
+fi
+
+if [[ ! -f build/checksums.txt ]]; then
+    echo "Error: missing build/checksums.txt, run bin/mk-dtk-bin.sh first" >&2
+    exit 1
+fi
+
+_VERSION=$(sed -n "s/.*VERSION = '\([^']*\)'.*/\1/p" src/Infrastructure/Symfony/Version.php)
+
+while read -r _sha _bin; do
+    case "${_bin}" in
+        *dtk-macos-x86_64)  _SHA_MACOS_X86="${_sha}" ;;
+        *dtk-macos-aarch64) _SHA_MACOS_ARM="${_sha}" ;;
+        *dtk-linux-x86_64)  _SHA_LINUX_X86="${_sha}" ;;
+        *dtk-linux-aarch64) _SHA_LINUX_ARM="${_sha}" ;;
+    esac
+done < build/checksums.txt
+
+echo ''
+echo '  // Updating Homebrew formula...'
+
+# \#{} is Ruby string interpolation; escaped here so bash passes it through literally
+cat > "${_TAP_DIR}/Formula/dtk.rb" <<FORMULA
+class Dtk < Formula
+  desc "Kanban, Git and Deployment, in one coherent flow"
+  homepage "https://github.com/ssc-php/dtk"
+  license "MIT"
+  version "${_VERSION}"
+
+  on_macos do
+    on_intel do
+      url "https://github.com/ssc-php/dtk/releases/download/v\#{version}/dtk-macos-x86_64"
+      sha256 "${_SHA_MACOS_X86}"
+    end
+
+    on_arm do
+      url "https://github.com/ssc-php/dtk/releases/download/v\#{version}/dtk-macos-aarch64"
+      sha256 "${_SHA_MACOS_ARM}"
+    end
+  end
+
+  on_linux do
+    on_intel do
+      url "https://github.com/ssc-php/dtk/releases/download/v\#{version}/dtk-linux-x86_64"
+      sha256 "${_SHA_LINUX_X86}"
+    end
+
+    on_arm do
+      url "https://github.com/ssc-php/dtk/releases/download/v\#{version}/dtk-linux-aarch64"
+      sha256 "${_SHA_LINUX_ARM}"
+    end
+  end
+
+  def install
+    bin.install Dir["dtk-*"].first => "dtk"
+  end
+
+  test do
+    assert_match version.to_s, shell_output("\#{bin}/dtk --version")
+  end
+end
+FORMULA
+
+git -C "${_TAP_DIR}" add Formula/dtk.rb
+git -C "${_TAP_DIR}" commit -m "chore: release v${_VERSION}"
+git -C "${_TAP_DIR}" push
+
+echo ''
+echo "  [OK] Updated Homebrew formula for v${_VERSION}"
+echo ''

bin/mk-release.sh

@@ -108,6 +108,9 @@ gh release create "${_TAG}" \
     build/dtk-windows-x86_64.exe \
     build/checksums.txt
 
+echo '  // Updating Homebrew tap...'
+"${_BIN_DIR}/mk-brew-formula.sh"
+
 echo ''
 echo "  [OK] Released ${_TAG}"
 echo ''

docs/how-to/002-how-to-release.md

@@ -32,6 +32,7 @@ This will:
 3. Create an annotated git tag `vX.Y.Z`
 4. Push the commit and tag
 5. Create a GitHub release with the binaries and `checksums.txt` attached
+6. Update the Homebrew formula in `ssc-php/homebrew-dtk` and push it
 
 ## Bump PHP version