node-red-contrib-homebridge-automation 0.3.0 → 0.3.1-beta.0

package/.github/dependabot.yml

@@ -11,3 +11,17 @@ updates:
     versions:
     - 13.2.0
     - 13.2.1
+  groups:
+    npm-dependencies:
+      patterns:
+        - "*"
+- package-ecosystem: github-actions
+  directory: "/"
+  schedule:
+    interval: daily
+    time: "10:00"
+  open-pull-requests-limit: 10
+  groups:
+    github-actions:
+      patterns:
+        - "*"

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

@@ -0,0 +1,97 @@
+#!/bin/env node
+
+/**
+ * This scripts queries the npm registry to pull out the latest version for a given tag.
+ */
+
+const assert = require('node:assert')
+const child_process = require('node:child_process')
+const fs = require('node:fs')
+const process = require('node:process')
+
+const BRANCH_VERSION_PATTERN = /^([A-Z]+)-(\d+\.\d+\.\d+)$/i
+
+// Load the contents of the package.json file
+const packageJSON = JSON.parse(fs.readFileSync('package.json', 'utf8'))
+
+const refArgument = process.argv[2]
+const tagArgument = process.argv[3] || 'latest'
+
+if (!refArgument) {
+  console.error('ref argument is missing')
+  console.error('Usage: npm-version-script.js <ref> [tag]')
+  process.exit(1)
+}
+
+/**
+ * Queries the NPM registry for the latest version for the provided base version and tag.
+ * If the tag is latest, then the base version is returned if it exists. For other tags, the latest
+ * version found for that base version and tag is returned.
+ * @param baseVersion The base version to query for, e.g. 2.0.0
+ * @param tag The tag to query for, e.g. beta or latest
+ * @returns {string} Returns the version, or '' if not found
+ */
+function getTagVersionFromNpm(baseVersion, tag) {
+  try {
+    return JSON.parse(child_process.execSync(`npm info ${packageJSON.name} versions --json`).toString('utf8').trim())
+      .filter(v => tag === 'latest' ? v === baseVersion : v.startsWith(`${baseVersion}-${tag}.`)) // find all published versions for this base version and tag
+      .reduce((_, current) => current, '') // choose the last as they're sorted in ascending order, or '' if there are none
+  } catch (e) {
+    console.error(`Failed to query the npm registry for the latest version for tag: ${tag}`, e)
+    // throw e;
+    return ''
+  }
+}
+
+function desiredTargetVersion(ref) {
+  // ref is a GitHub action ref string
+  if (ref.startsWith('refs/pull/')) {
+    throw new Error('The version script was executed inside a PR!')
+  }
+
+  assert(ref.startsWith('refs/heads/'))
+  const branchName = ref.slice('refs/heads/'.length)
+
+  const 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]
+  }
+
+  throw new Error(`Malformed branch name for ref: ${ref}. Can't derive the base version. Use a branch name like: beta-x.x.x or alpha-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(baseVersion, tagArgument) // e.g. 0.7.0-beta.12
+
+let publishTag
+
+if (latestReleasedVersion) {
+  console.warn(`Latest published version for ${baseVersion} with tag ${tagArgument} is ${latestReleasedVersion}`)
+  publishTag = latestReleasedVersion // set this released beta or alpha to be incremented
+} else {
+  console.warn(`No published versions for ${baseVersion} with tag ${tagArgument}`)
+  publishTag = baseVersion // start off with a new beta or alpha version
+}
+
+if (packageJSON.version !== publishTag) {
+  // report the change for CI
+  console.warn(`Changing version in package.json from ${packageJSON.version} to ${publishTag}`)
+
+  // save the package.json
+  packageJSON.version = publishTag
+  fs.writeFileSync('package.json', JSON.stringify(packageJSON, null, 2))
+
+  // perform the same change to the package-lock.json
+  const packageLockJSON = JSON.parse(fs.readFileSync('package-lock.json', 'utf8'))
+  packageLockJSON.version = publishTag
+  fs.writeFileSync('package-lock.json', JSON.stringify(packageLockJSON, null, 2))
+} else {
+  console.warn(`Leaving version in package.json at ${packageJSON.version}`)
+}

package/.github/workflows/Build and Publish.yml

@@ -1,43 +1,47 @@
-name:
-  'Build, Publish and Release'
-
-  #
-  # Automatically publish beta releases on pushes, require a manual workflow action for production releases
-  #
-  # Does the following
-  # 1 - Run the documentation script against the package
-  # 2 - Create the npm package using the package.json version tag ( or for beta releases, adds a beta tag and increments as needed )
-  # 3 - Publish the npm package
-  # 4 - For releases against the latest branch, create a github release as well
+name: "Build, Publish and Release"
+
+ 
+ #
+ # Automatically publish beta releases on pushes, require a manual workflow action for production releases
+ #
+ # Does the following
+ # 1 - Run the documentation script against the package
+ # 2 - Create the npm package using the package.json version tag ( or for beta releases, adds a beta tag and increments as needed )
+ # 3 - Publish the npm package
+ # 4 - For releases against the main branch, create a github release as well
 
 on:
   push:
     branches: [beta-*.*.*, beta]
   workflow_dispatch:
 
+concurrency:
+  group: build_and_publish
+  cancel-in-progress: true
+
 jobs:
   get_tags:
     runs-on: ubuntu-latest
 
     steps:
-      # checkout repo
-      - uses: actions/checkout@v4
-
-      # get branch / tag name
-      - name: Get Branch / Tag Name
-        id: get_branch
-        run: |
-          export BRANCH_NAME=$(if [[ ${GITHUB_REF} =~ "refs/tags/" ]]; then echo ${GITHUB_REF/refs\/tags\//}; else echo ${GITHUB_REF/refs\/heads\//}; fi)
-          echo $BRANCH_NAME
-          echo "BRANCH_NAME=${BRANCH_NAME}" >> $GITHUB_OUTPUT
-
-      # generate the image tag
-      - name: Get Image Tag
-        id: get_tag
-        run: |
-          export TARGET_IMAGE_TAG=$(if [ "${{ steps.get_branch.outputs.BRANCH_NAME }}" = "main" ]; then echo "main"; else echo "${{ steps.get_branch.outputs.BRANCH_NAME }}" | awk -F- '{ print $1 }'; fi)
-          echo $TARGET_IMAGE_TAG
-          echo "TARGET_IMAGE_TAG=${TARGET_IMAGE_TAG}" >> $GITHUB_OUTPUT
+    # checkout repo
+    - uses: actions/checkout@v5
+
+    # get branch / tag name
+    - name: Get Branch / Tag Name
+      id: get_branch
+      run: |
+        export BRANCH_NAME=$(if [[ ${GITHUB_REF} =~ "refs/tags/" ]]; then echo ${GITHUB_REF/refs\/tags\//}; else echo ${GITHUB_REF/refs\/heads\//}; fi)
+        echo $BRANCH_NAME
+        echo "BRANCH_NAME=${BRANCH_NAME}" >> $GITHUB_OUTPUT
+
+    # generate the image tag
+    - name: Get Image Tag
+      id: get_tag
+      run: |
+        export TARGET_IMAGE_TAG=$(if [ "${{ steps.get_branch.outputs.BRANCH_NAME }}" = "main" ]; then echo "main"; else echo "${{ steps.get_branch.outputs.BRANCH_NAME }}" | awk -F- '{ print $1 }'; fi)
+        echo $TARGET_IMAGE_TAG
+        echo "TARGET_IMAGE_TAG=${TARGET_IMAGE_TAG}" >> $GITHUB_OUTPUT
 
     outputs:
       BRANCH_NAME: ${{ steps.get_branch.outputs.BRANCH_NAME }}
@@ -47,38 +51,38 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      # checkout repo
-      - uses: actions/checkout@v4
-        with:
-          persist-credentials: false # otherwise, the token used is the GITHUB_TOKEN, instead of your personal access token.
-          fetch-depth: 0 # otherwise, there would be errors pushing refs to the destination repository.
-
-      - uses: actions/setup-node@v4
-        with:
-          node-version: lts/*
-
-      - name: Retrieve github-markdown-toc
-        run: |
-          wget -q https://raw.githubusercontent.com/ekalinin/github-markdown-toc/master/gh-md-toc
-          chmod a+x gh-md-toc
-
-      - name: Create Table of Contents
-        run: |
-          npm run-script document --if-present
-          rm gh-md-toc
-
-      - name: Commit files
-        run: |
-          git config --local user.email "github-actions[bot]@users.noreply.github.com"
-          git config --local user.name "github-actions[bot]"
-          git add * || true
-          git commit -a -m "Update TOC" || true
-
-      - name: Push changes
-        uses: ad-m/github-push-action@master
-        with:
-          github_token: ${{ secrets.GITHUB_TOKEN }}
-          branch: ${{ github.ref }}
+    # checkout repo
+    - uses: actions/checkout@v5
+      with:
+        persist-credentials: false # otherwise, the token used is the GITHUB_TOKEN, instead of your personal access token.
+        fetch-depth: 0 # otherwise, there would be errors pushing refs to the destination repository.
+
+    - uses: actions/setup-node@v6
+      with:
+        node-version: lts/*
+
+    - name: Retrieve github-markdown-toc
+      run: |
+        wget -q https://raw.githubusercontent.com/ekalinin/github-markdown-toc/master/gh-md-toc
+        chmod a+x gh-md-toc
+
+    - name: Create Table of Contents
+      run: |
+        npm run-script document
+        rm gh-md-toc
+
+    - name: Commit files
+      run: |
+        git config --local user.email "github-actions[bot]@users.noreply.github.com"
+        git config --local user.name "github-actions[bot]"
+        git add *
+        git commit -a -m "Update TOC" || true
+
+    - name: Push changes
+      uses: ad-m/github-push-action@master
+      with:
+        github_token: ${{ secrets.GITHUB_TOKEN }}
+        branch: ${{ github.ref }}
 
   publish_prod_release:
     permissions:
@@ -88,9 +92,9 @@ jobs:
     if: ${{ needs.get_tags.outputs.BRANCH_NAME == 'main' }}
     uses: homebridge/.github/.github/workflows/npm-publish.yml@latest
     with:
-      install_cmd: npm ci 
+      install_cmd: npm ci
     secrets:
-      npm_auth_token: ${{ secrets.NPM_TOKEN }}
+      npm_auth_token: ${{ secrets.npm_token }}
 
   publish_test_release:
     permissions:
@@ -102,24 +106,23 @@ jobs:
     with:
       tag: ${{ needs.get_tags.outputs.TARGET_IMAGE_TAG }}
       dynamically_adjust_version: true
-      npm_version_command: pre
+      npm_version_command: 'pre'
       pre_id: ${{ needs.get_tags.outputs.TARGET_IMAGE_TAG }}
-      install_cmd: npm ci 
     secrets:
-      npm_auth_token: ${{ secrets.NPM_TOKEN }}
+      npm_auth_token: ${{ secrets.npm_token }}
 
   publish_github_release:
     needs: [publish_prod_release]
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
-      - name: Create Release
-        uses: softprops/action-gh-release@v1
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        with:
-          tag_name: ${{ needs.publish_prod_release.outputs.NPM_VERSION }}
-          name: Release ${{ needs.publish_prod_release.outputs.NPM_VERSION }}
-          generate_release_notes: true
-          draft: false
-          prerelease: false
+    - uses: actions/checkout@v5
+    - name: Create Release
+      uses: softprops/action-gh-release@v2
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      with:
+        tag_name: ${{ needs.publish_prod_release.outputs.NPM_VERSION }}
+        name: Release ${{ needs.publish_prod_release.outputs.NPM_VERSION }}
+        generate_release_notes: true
+        draft: false
+        prerelease: false

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "node-red-contrib-homebridge-automation",
-  "version": "0.3.0",
+  "version": "0.3.1-beta.0",
   "description": "NodeRED Automation for HomeBridge",
   "main": "src/HAP-NodeRed.js",
   "scripts": {
@@ -76,4 +76,4 @@
       "!src/test-utils"
     ]
   }
-}
+}