feat: implement professional distribution system (DMG, Homebrew, One-liner, GitHub Actions)

will2022 · will2022 · commit 7863200582ab · 2026-04-01T01:49:32.000+02:00
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -0,0 +1,37 @@
+name: Build and Release
+
+on:
+  push:
+    tags:
+      - 'v*'
+
+jobs:
+  build:
+    name: Build & Package
+    runs-on: macos-14
+    permissions:
+      contents: write
+
+    steps:
+      - name: Checkout Code
+        uses: actions/checkout@v4
+
+      - name: Run Build Script
+        run: |
+          chmod +x build.sh
+          ./build.sh
+
+      - name: Run Package Script
+        run: |
+          chmod +x package.sh
+          ./package.sh
+
+      - name: Create GitHub Release
+        id: create_release
+        uses: softprops/action-gh-release@v2
+        with:
+          files: ChargeControl.dmg
+          draft: false
+          prerelease: false
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
diff --git a/.gitignore b/.gitignore
@@ -27,3 +27,6 @@ Thumbs.db
 *~
 test_*.swift
 check_*.swift
+
+# Disk images
+*.dmg
diff --git a/README.md b/README.md
@@ -48,40 +48,68 @@ Unlike standard macOS battery management, ChargeControl gives you direct control
 
 ## 🛠️ Installation & Setup
 
-### 1. Build from Source
+Choose your preferred way to install ChargeControl.
 
+### 1. The "Standard Mac" way (DMG) [Recommended]
+1. Go to the [Releases](https://github.com/will2022/ChargeControl/releases) page.
+2. Download the latest `ChargeControl.dmg`.
+3. Double-click the DMG and drag **ChargeControl** to your **Applications** folder.
+
+### 2. The Homebrew way
+If you have [Homebrew](https://brew.sh) installed, run:
+```bash
+brew tap will2022/chargecontrol
+brew install --cask will2022/chargecontrol/chargecontrol
+```
+
+### 3. The One-Liner (Terminal)
+Run this command to automatically download and install the latest release:
+```bash
+curl -sL https://raw.githubusercontent.com/will2022/ChargeControl/main/install.sh | bash
+```
+
+### 4. Build from Source (Developers)
 1. Clone the repository:
    ```bash
    git clone https://github.com/will2022/ChargeControl.git
-   cd ChargeControl/ChargeControl
+   cd ChargeControl
    ```
-2. Run the build script:
+2. Build the app:
    ```bash
    ./build.sh
+   ./package.sh  # To generate the DMG
    ```
-   The built application will be located at `build/ChargeControl.app`.
+3. Move `build/ChargeControl.app` to `/Applications`.
 
-### 2. Install to Applications
+---
 
-For the background daemon to work reliably with macOS security policies (`SMAppService`), it is recommended to move the app to your `/Applications` folder:
+## 🛡️ Security & Permissions
 
-```bash
-cp -R build/ChargeControl.app /Applications/
-```
+Because ChargeControl is currently distributed independently and interacts with low-level system hardware (SMC), you will likely encounter macOS security warnings.
+
+### 1. "Unidentified Developer" Warning
+When you first try to open the app, macOS may block it because it isn't signed with an Apple Developer Certificate.
+- **The Fix:** Don't just double-click it. **Right-click (or Control-click)** the app icon and select **Open**. This will present a dialog with an "Open" button that isn't usually there, allowing you to bypass the check.
+
+### 2. Administrator Password
+Once opened, the app needs to install a background helper daemon (`ChargeControlDaemon`) to talk to your battery hardware.
+- **The Fix:** You will be prompted for your **Administrator Password**. This is required for the app to enforce your battery limits while your Mac is asleep or on the lock screen.
 
-### 3. Install the CLI (Optional)
+### 3. Background Items
+You may see a system notification that "ChargeControl" has added a background item. This is normal and necessary for the daemon to stay active.
+
+---
+
+## ⌨️ Installing the CLI (Optional)
+
+The `cc` command-line tool allows you to control the app from the terminal. 
+- If you installed via **Homebrew** or the **One-Liner**, the CLI is already installed!
+- If you installed via the **DMG** or built from source, you can symlink it manually:
 
-To use the CLI from anywhere, symlink the binary to your path:
 ```bash
 sudo ln -s /Applications/ChargeControl.app/Contents/MacOS/cc /usr/local/bin/cc
 ```
 
-### 4. First Run & Permissions
-
-1. Open `ChargeControl.app` from your `/Applications` folder.
-2. The app will attempt to register its privileged helper tool (`ChargeControlDaemon`).
-3. **Password Prompt:** macOS will prompt you for your administrator password to authorize the background service.
-
 ---
 
 ## 📖 Usage
diff --git a/install.sh b/install.sh
@@ -0,0 +1,48 @@
+#!/bin/bash
+set -e
+
+REPO="will2022/ChargeControl"
+APP_NAME="ChargeControl.app"
+APP_DEST="/Applications/ChargeControl.app"
+
+echo "🚀 Installing ChargeControl..."
+
+# 1. Fetch latest release info
+echo "Step 1: Finding latest version..."
+LATEST_RELEASE=$(curl -s "https://api.github.com/repos/$REPO/releases/latest")
+DOWNLOAD_URL=$(echo "$LATEST_RELEASE" | grep "browser_download_url.*ChargeControl.dmg" | cut -d '"' -f 4)
+
+if [ -z "$DOWNLOAD_URL" ]; then
+    echo "❌ Error: Could not find the latest DMG release on GitHub."
+    exit 1
+fi
+
+# 2. Download DMG
+echo "Step 2: Downloading ChargeControl.dmg..."
+curl -L -o /tmp/ChargeControl.dmg "$DOWNLOAD_URL"
+
+# 3. Mount DMG
+echo "Step 3: Mounting Disk Image..."
+MOUNT_POINT=$(hdiutil attach /tmp/ChargeControl.dmg -nobrowse | grep /Volumes | awk '{print $3}')
+
+# 4. Install App
+echo "Step 4: Installing to /Applications..."
+if [ -d "$APP_DEST" ]; then
+    echo "⚠️ Existing version found. Replacing..."
+    sudo rm -rf "$APP_DEST"
+fi
+sudo cp -R "$MOUNT_POINT/$APP_NAME" /Applications/
+
+# 5. Cleanup
+echo "Step 5: Cleaning up..."
+hdiutil detach "$MOUNT_POINT"
+rm /tmp/ChargeControl.dmg
+
+# 6. Optional: Link CLI
+echo "Step 6: Setting up 'cc' command..."
+if [ ! -L /usr/local/bin/cc ]; then
+    sudo ln -s "$APP_DEST/Contents/MacOS/cc" /usr/local/bin/cc
+    echo "✅ 'cc' command linked to /usr/local/bin/cc"
+fi
+
+echo "🎉 Finished! You can now open ChargeControl from your Applications folder."
diff --git a/package.sh b/package.sh
@@ -0,0 +1,40 @@
+#!/bin/bash
+set -e
+
+# Configuration
+APP_NAME="ChargeControl"
+BUILD_DIR="build"
+DMG_NAME="${APP_NAME}.dmg"
+DMG_ROOT="dmg_root"
+
+echo "📦 Packaging $APP_NAME into $DMG_NAME..."
+
+# 1. Ensure we have a fresh build
+if [ ! -d "$BUILD_DIR/${APP_NAME}.app" ]; then
+    echo "⚠️ Build not found. Running build.sh first..."
+    ./build.sh
+fi
+
+# 2. Setup DMG root folder
+echo "Step 1: Setting up temporary packaging folder..."
+rm -rf "$DMG_ROOT"
+mkdir -p "$DMG_ROOT"
+
+# 3. Copy the compiled app
+echo "Step 2: Copying $APP_NAME.app..."
+cp -R "$BUILD_DIR/${APP_NAME}.app" "$DMG_ROOT/"
+
+# 4. Create a symlink to /Applications for the user
+echo "Step 3: Creating /Applications symlink..."
+ln -s /Applications "$DMG_ROOT/Applications"
+
+# 5. Create the DMG using hdiutil
+echo "Step 4: Building the Disk Image (hdiutil)..."
+rm -f "$DMG_NAME"
+hdiutil create -volname "$APP_NAME" -srcfolder "$DMG_ROOT" -ov -format UDZO "$DMG_NAME"
+
+# 6. Cleanup
+echo "Step 5: Cleaning up..."
+rm -rf "$DMG_ROOT"
+
+echo "✅ Success! $DMG_NAME is ready for release."
