@switchbot/homebridge-switchbot 3.8.3 → 4.0.0-beta.1

package/.github/npm-version-script.cjs

@@ -0,0 +1,81 @@
+#!/bin/env node
+
+/**
+ * This scripts queries the npm registry to pull out the latest version for a given tag.
+ */
+
+const fs = require("fs");
+const semver = require("semver");
+const child_process = require("child_process");
+const assert = require("assert");
+
+const BRANCH_VERSION_PATTERN = /^([A-Za-z]*)-(\d+.\d+.\d+)$/
+
+// Load the contents of the package.json file
+const packageJSON = JSON.parse(fs.readFileSync("package.json", "utf8"));
+
+let refArgument = process.argv[2];
+let tagArgument = process.argv[3] || "latest";
+
+if (refArgument == null) {
+  console.error("ref argument is missing");
+  console.error("Usage: npm-version-script.cjs <ref> [tag]");
+  process.exit(1);
+}
+
+/**
+ * Queries the NPM registry for the latest version for the provided tag.
+ * @param tag The tag to query for.
+ * @returns {string} Returns the version.
+ */
+function getTagVersionFromNpm(tag) {
+  try {
+    return child_process.execSync(`npm info ${packageJSON.name} version --tag="${tag}"`).toString("utf8").trim();
+  } catch (e) {
+    throw e;
+  }
+}
+
+function desiredTargetVersion(ref) {
+  // ref is a GitHub action ref string
+  if (ref.startsWith("refs/pull/")) {
+    throw Error("The version script was executed inside a PR!");
+  }
+
+  assert(ref.startsWith("refs/heads/"))
+  let branchName = ref.slice("refs/heads/".length);
+
+  let results = branchName.match(BRANCH_VERSION_PATTERN);
+  if (results != null) {
+    if (results[1] !== tagArgument) {
+      console.warn(`The base branch name (${results[1]}) differs from the tag name ${tagArgument}`);
+    }
+
+    return results[2];
+  }
+
+  // legacy mode were we use the `betaVersion` property in the package.json
+  if (branchName === "beta" && packageJSON.betaVersion) {
+    return packageJSON.betaVersion
+  }
+
+  throw new Error("Malformed branch name for ref: " + ref + ". Can't derive the base version. Use a branch name like: beta-x.x.x!");
+}
+
+// derive the base version from the branch ref
+const baseVersion = desiredTargetVersion(refArgument);
+
+// query the npm registry for the latest version of the provided tag name
+const latestReleasedVersion = getTagVersionFromNpm(tagArgument); // e.g. 0.7.0-beta.12
+const latestReleaseBase = semver.inc(latestReleasedVersion, "patch"); // will produce 0.7.0 (removing the preid, needed for the equality check below)
+
+let publishTag;
+if (semver.eq(baseVersion, latestReleaseBase)) { // check if we are releasing another version for the latest beta
+  publishTag = latestReleasedVersion; // set the current latest beta to be incremented
+} else {
+  publishTag = baseVersion; // start of with a new beta version
+}
+
+// save the package.json
+packageJSON.version = publishTag;
+fs.writeFileSync("package.json", JSON.stringify(packageJSON, null, 2));

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

@@ -3,8 +3,6 @@ name: Node-CI Beta
 on:
   push:
     branches: [beta-*.*.*, beta]
-  release:
-    types: [prereleased]
   workflow_dispatch:
 
 jobs:
@@ -14,15 +12,14 @@ jobs:
       enable_coverage: true
     secrets:
       token: ${{ secrets.GITHUB_TOKEN }}
+
   lint:
     needs: build_and_test
     uses: OpenWonderLabs/.github/.github/workflows/eslint.yml@latest
 
   publish:
     needs: lint
-
     if: ${{ github.repository == 'OpenWonderLabs/homebridge-switchbot' }}
-
     uses: OpenWonderLabs/.github/.github/workflows/npm-publish.yml@latest
     with:
       tag: 'beta'
@@ -32,6 +29,17 @@ jobs:
     secrets:
       npm_auth_token: ${{ secrets.npm_token }}
 
+  pre-release:
+    needs: publish
+    if: ${{ github.repository == 'OpenWonderLabs/homebridge-switchbot' }}
+    uses: OpenWonderLabs/.github/.github/workflows/pre-release.yml@latest
+    with:
+      npm_version: ${{ needs.publish.outputs.NPM_VERSION }}
+      body: |
+        **Beta Release**
+        **Version**: v${{ needs.publish.outputs.NPM_VERSION }}
+        [How To Test Beta Releases](https://github.com/OpenWonderLabs/homebridge-switchbot/wiki/Beta-Version)
+
   github-releases-to-discord:
     name: Discord Webhooks
     needs: [build_and_test,publish]

package/CHANGELOG.md

@@ -2,11 +2,25 @@
 
 All notable changes to this project will be documented in this file. This project uses [Semantic Versioning](https://semver.org/)
 
+## [4.0.0](https://github.com/OpenWonderLabs/homebridge-switchbot/releases/tag/v4.0.0) (2024-10-XX)
+
+### What's Changed
+#### ⚠️ Breaking Changes
+- OpenAPI is now support by Version [3.0.0](https://github.com/OpenWonderLabs/node-switchbot/releases/latest) of [`node-switchbot`](https://github.com/OpenWonderLabs/node-switchbot), so made changes to refect that.
+- Moved all device specific configs to all the same levels to elimate the use of multiple of the same config.
+  - **If you have config set for any of the following SwitchBot device Types: `Curtain`, `Blind Tilt`, `Color Bulb`, `Strip Light`, `Hub`, `Meter`, `Meter Plus`, `Humidifier`, `Contact Sensor`, `Motion Sensor`, `Water Detector`, `Ceiling Light`, or `Lock`; you will need to re-setup your config for that deviceId**
+  - **If you have config set for any of the following IR device Types: `Fan`, `DIY Fan`, `Light`, `DIY Light`, `Air Conditioner`, `DIY Air Conditioner`, or `Others`; you will need to re-setup your config for that deviceId**
+
+#### Other Changes
+- Housekeeping and updated dependencies.
+
+**Full Changelog**: https://github.com/OpenWonderLabs/homebridge-switchbot/compare/v3.8.3...v4.0.0
+
 ## [3.8.3](https://github.com/OpenWonderLabs/homebridge-switchbot/releases/tag/v3.8.3) (2024-10-09)
 
 ### What's Changed
 - Fix incorrect handling of openState in Contact Sensor [#1061](https://github.com/OpenWonderLabs/homebridge-switchbot/pull/1061), Thanks [@nzws](https://github.com/nzws)
-- Fix light level stuck at ma [#1066](https://github.com/OpenWonderLabs/homebridge-switchbot/pull/1066), Thanks [@4gra](https://github.com/4gra)
+- Fix light level stuck at max [#1066](https://github.com/OpenWonderLabs/homebridge-switchbot/pull/1066), Thanks [@4gra](https://github.com/4gra)
 - Housekeeping and updated dependencies.
 
 **Full Changelog**: https://github.com/OpenWonderLabs/homebridge-switchbot/compare/v3.8.2...v3.8.3