@homebridge-plugins/homebridge-smarthq 0.5.0-beta.5 → 0.5.0-beta.7

package/.github/ISSUE_TEMPLATE/config.yml

@@ -1,4 +1,4 @@
-blank_issues_enabled: false
+blank_issues_enabled: true
 contact_links:
   - name: Homebridge Discord Channel for SmartHQ
     url: https://discord.gg/8fpZA4S

package/.github/copilot-instructions.md

@@ -0,0 +1,90 @@
+# GitHub Copilot Instructions for homebridge-smarthq
+
+## Branch Management and PR Workflow
+
+### Current Project State
+
+- **Stable branch**: `latest` (version 0.4.0)
+- **Active beta branch**: `beta-0.5.0` (currently at v0.5.0-beta.4)
+- **Main development**: All new features and non-critical fixes should target `beta-0.5.0`
+- **Critical patches**: For urgent fixes to stable release, may target new `beta-0.4.x` branch
+
+### Branch Targeting Requirements
+
+All pull requests **MUST** be directed to a beta branch first, never directly to the main branch (`latest`). This ensures proper testing and gradual release management.
+
+### Beta Branch Creation
+
+If no appropriate beta branch exists, create one based on the next possible version using semantic versioning:
+
+1. **Current stable version**: Check `package.json` in the `latest` branch for the current stable version (currently 0.4.0)
+2. **Current beta version**: Check if `beta-0.5.0` exists and is active (currently has v0.5.0-beta.4)
+3. **Determine next version** based on change type:
+   - **Patch** (bug fixes): If working on 0.4.x patches → create `beta-0.4.1`
+   - **Minor** (new features): Use existing `beta-0.5.0` or create next minor version
+   - **Major** (breaking changes): 1.0.0 → create `beta-1.0.0`
+
+4. **Create beta branch** from the latest stable branch (if needed):
+   ```bash
+   git fetch origin
+   git checkout latest
+   git pull origin latest
+   git checkout -b beta-X.Y.Z
+   git push origin beta-X.Y.Z
+   ```
+
+**Current Status**: `beta-0.5.0` branch exists and is active with several beta releases (v0.5.0-beta.1 through v0.5.0-beta.4)
+
+### Required Labels Before Assignment
+
+Before assigning any issue to Copilot, the following labels **MUST** be set to determine the semantic version increment:
+
+- **`patch`** - For bug fixes, security patches, documentation updates, and other non-feature changes
+- **`minor`** - For new features, enhancements, and backwards-compatible additions
+- **`major`** - For breaking changes, API changes, and backwards-incompatible modifications
+
+### PR Workflow
+
+1. **Check for appropriate beta branch**: Look for existing beta branches that match the intended version
+2. **Create beta branch if needed**: If no appropriate beta branch exists, create one as described above
+3. **Target the beta branch**: Always target PRs to the beta branch, not `latest`
+4. **Use semantic versioning**: Ensure the target beta branch version aligns with the change type (patch/minor/major)
+
+### Branch Naming Convention
+
+- Main development branch: `latest`
+- Beta branches: `beta-X.Y.Z` (e.g., `beta-0.5.0`, `beta-0.4.1`, `beta-1.0.0`)
+- Feature branches: Follow standard naming (e.g., `feature/add-support-for-xyz`, `fix/bug-description`)
+
+### Release Process
+
+1. **Beta releases**: PRs merge to beta branches → trigger beta release workflow
+2. **Stable releases**: Beta branches merge to `latest` → trigger main release workflow
+
+### Examples
+
+#### For a Bug Fix (patch):
+- Label: `patch`
+- Target branch: `beta-0.4.1` (for patches to stable 0.4.0) or `beta-0.5.0` (for patches to upcoming 0.5.0)
+- If targeting patches to stable release, create `beta-0.4.1` from `latest`
+- If targeting current development, use existing `beta-0.5.0`
+
+#### For a New Feature (minor):
+- Label: `minor` 
+- Target branch: `beta-0.5.0` (currently active beta branch)
+- Use existing `beta-0.5.0` branch which is actively receiving minor updates
+
+#### For Breaking Changes (major):
+- Label: `major`
+- Target branch: `beta-1.0.0` (if current beta is 0.5.0)
+- Create `beta-1.0.0` from current `beta-0.5.0` or `latest` as appropriate
+
+### Validation
+
+Before creating any PR, ensure:
+- [ ] Appropriate label (patch/minor/major) is set on the issue
+- [ ] Target beta branch exists or has been created
+- [ ] Beta branch version matches the semantic version implied by the label
+- [ ] All changes are focused and minimal for the specific issue being addressed
+
+This workflow ensures proper version management, thorough testing through beta releases, and maintains stability of the main codebase.

package/.github/scripts/branch-helper.sh

@@ -0,0 +1,41 @@
+#!/bin/bash
+
+# Branch Target Helper for homebridge-smarthq
+# This script helps determine which beta branch to target based on change type
+
+echo "🏠 Homebridge SmartHQ - Branch Target Helper"
+echo "==========================================="
+echo
+
+# Ensure we have the latest remote info
+git fetch origin >/dev/null 2>&1
+
+# Get current versions
+STABLE_VERSION=$(git show latest:package.json 2>/dev/null | grep '"version"' | cut -d'"' -f4)
+BETA_BRANCHES=$(git branch -r | grep "origin/beta-" | sed 's/.*origin\///' | sort -V)
+
+echo "📊 Current State:"
+echo "  Stable version (latest): $STABLE_VERSION"
+echo "  Available beta branches:"
+if [ -z "$BETA_BRANCHES" ]; then
+    echo "    - beta-0.5.0 (active development - v0.5.0-beta.4)"
+else
+    for branch in $BETA_BRANCHES; do
+        echo "    - $branch"
+    done
+fi
+echo
+
+echo "🎯 Branch Targeting Guide:"
+echo "  🐛 Bug fixes (patch):     beta-0.4.1 (patches) or beta-0.5.0 (development)"
+echo "  ✨ New features (minor):  beta-0.5.0 (active development)"
+echo "  💥 Breaking changes:      beta-1.0.0 (create if needed)"
+echo
+
+echo "📋 Required Labels:"
+echo "  - patch: Bug fixes, security patches, documentation"
+echo "  - minor: New features, enhancements" 
+echo "  - major: Breaking changes, API changes"
+echo
+
+echo "⚠️  Remember: ALL PRs must target beta branches, never 'latest' directly!"

package/.github/workflows/beta-release.yml

@@ -52,4 +52,4 @@ jobs:
         Version `v${{ needs.publish.outputs.NPM_VERSION }}`
       url: "https://github.com/homebridge-plugins/homebridge-smarthq/releases/tag/v${{ needs.publish.outputs.NPM_VERSION }}"
     secrets:
-      DISCORD_WEBHOOK: ${{ secrets.DISCORD_WEBHOOK_URL_BETA || secrets.DISCORD_WEBHOOK_URL_LATEST }}
+      DISCORD_WEBHOOK: ${{ secrets.DISCORD_WEBHOOK_URL_BETA || secrets.DISCORD_WEBHOOK_URL_LATEST }}

package/.github/workflows/release.yml

@@ -1,35 +1,71 @@
-name: Release
+name: Unified Release
 
 on:
-  release:
-    types: [published]
+  push:
+    branches:
+      #- "alpha-*"
+      #- "beta-*"
+      - latest
+  workflow_dispatch:
 
 jobs:
-  build_and_test:
-    uses: homebridge/.github/.github/workflows/nodejs-build-and-test.yml@latest
+  # 1️⃣ Determine release type, ESM status, and branch name
+  determine-release-type:
+    uses: homebridge/.github/.github/workflows/determine-release-type.yml@latest
     with:
-      enable_coverage: false
-    secrets:
-      token: ${{ secrets.GITHUB_TOKEN }}
+      ref_name: ${{ github.ref_name }}
+
+  # 2️⃣ Update version and changelog using the scripts
+  update-version:
+    needs: determine-release-type
+    uses: homebridge/.github/.github/workflows/update-version.yml@latest
+    with:
+      release_type: ${{ needs.determine-release-type.outputs.release_type }}
+      is_esm: ${{ needs.determine-release-type.outputs.is_esm == 'true' }}
 
-  publish:
-    needs: build_and_test
-    if: ${{ github.repository == 'homebridge-plugins/homebridge-smarthq' }}
+  # 3️⃣ Publish to NPM and create GitHub release
+  publish-release:
+    needs: [determine-release-type, update-version]
     permissions:
       id-token: write
-    uses: homebridge/.github/.github/workflows/npm-publish-esm.yml@latest
+      contents: write
+    uses: homebridge/.github/.github/workflows/publish-release.yml@latest
+    with:
+      release_type: ${{ needs.determine-release-type.outputs.release_type }}
+      version: ${{ needs.update-version.outputs.version }}
+      is_esm: ${{ needs.determine-release-type.outputs.is_esm == 'true' }}
     secrets:
-      npm_auth_token: ${{ secrets.npm_token }}
+      NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+
+  # 4️⃣ Promote branch if this is a prerelease (alpha/beta)
+  promote-branch:
+    needs: [determine-release-type, publish-release]
+    if: ${{ needs.determine-release-type.outputs.release_type != 'latest' && needs.determine-release-type.outputs.release_type != 'skip' }}
+    uses: homebridge/.github/.github/workflows/promote-branch.yml@latest
+    with:
+      branch_name: ${{ needs.determine-release-type.outputs.branch_name }}
+      release_type: ${{ needs.determine-release-type.outputs.release_type }}
+      is_esm: ${{ needs.determine-release-type.outputs.is_esm == 'true' }}
+
+  # 5️⃣ Notify if any previous job fails
+  workflow-failure:
+    if: ${{ failure() }}
+    needs: [determine-release-type, update-version, publish-release, promote-branch]
+    uses: homebridge/.github/.github/workflows/report-failure.yml@latest
+    with:
+      workflow_name: ${{ github.workflow }}
+      job_name: ${{ github.job }}
+      run_url: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}
 
+  # 6️⃣ Post to Discord
   github-releases-to-discord:
     name: Discord Webhooks
-    needs: [build_and_test,publish]
-    if: ${{ github.repository == 'homebridge-plugins/homebridge-smarthq' }}
+    needs: [determine-release-type, update-version, publish-release]
     uses: homebridge/.github/.github/workflows/discord-webhooks.yml@latest
     with:
       title: "SmartHQ Release"
       description: |
-        Version `v${{ needs.publish.outputs.NPM_VERSION }}`
-      url: "https://github.com/homebridge-plugins/homebridge-smarthq/releases/tag/v${{ needs.publish.outputs.NPM_VERSION }}"
+        Version `v${{ needs.update-version.outputs.version }}`
+      url: "https://github.com/homebridge-plugins/homebridge-smarthq/releases/tag/v${{ needs.update-version.outputs.version }}"
     secrets:
       DISCORD_WEBHOOK: ${{ secrets.DISCORD_WEBHOOK_URL_LATEST }}