cordova-plugin-ymchat 3.4.2 → 3.4.3

package/.github/workflows/release.yml

@@ -0,0 +1,104 @@
+name: Release
+
+# Reproduces this repo's existing manual release process: whenever a push to
+# main carries a version in package.json that hasn't been tagged yet, tag
+# that commit (vX.Y.Z), publish a GitHub Release whose body is the matching
+# CHANGELOG.md section, and publish the package to npm. A push to main that
+# isn't a release (its package.json version is already tagged) is a no-op.
+#
+# Tag/release creation and the npm publish are gated independently: tag+
+# release only happen for a not-yet-tagged version, but npm publish is
+# retried on every run (including a manual workflow_dispatch, e.g. to
+# recover from a publish failure) as long as that version isn't on npm yet.
+#
+# Requires an NPM_TOKEN repo secret (an npm token created with 2FA-bypass —
+# "Automation" for a classic token, or the "Bypass two-factor authentication"
+# checkbox for a granular token — otherwise `npm publish` fails with
+# EOTP/E403 since CI can't supply a one-time password).
+
+on:
+  push:
+    branches: [main]
+  workflow_dispatch: {}
+
+permissions:
+  contents: write
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Determine version from package.json
+        id: version
+        run: |
+          VERSION="$(sed -n 's/.*"version"[[:space:]]*:[[:space:]]*"\([^"]*\)".*/\1/p' package.json | head -1)"
+          if [[ -z "$VERSION" ]]; then
+            echo "::error::could not read version from package.json"
+            exit 1
+          fi
+          echo "version=$VERSION" >> "$GITHUB_OUTPUT"
+          echo "tag=v$VERSION" >> "$GITHUB_OUTPUT"
+
+      - name: Check whether this version is already released
+        id: check
+        run: |
+          if git rev-parse -q --verify "refs/tags/${{ steps.version.outputs.tag }}" >/dev/null; then
+            echo "already_tagged=true" >> "$GITHUB_OUTPUT"
+          else
+            echo "already_tagged=false" >> "$GITHUB_OUTPUT"
+          fi
+
+          if npm view "cordova-plugin-ymchat@${{ steps.version.outputs.version }}" version >/dev/null 2>&1; then
+            echo "already_published=true" >> "$GITHUB_OUTPUT"
+          else
+            echo "already_published=false" >> "$GITHUB_OUTPUT"
+          fi
+
+      - name: Extract CHANGELOG section
+        if: steps.check.outputs.already_tagged == 'false'
+        id: changelog
+        run: |
+          VERSION="${{ steps.version.outputs.version }}"
+          NOTES_FILE="$(mktemp)"
+          if ! ./scripts/extract_changelog_section.sh "$VERSION" CHANGELOG.md > "$NOTES_FILE"; then
+            echo "::error::no CHANGELOG.md section found for $VERSION"
+            exit 1
+          fi
+          echo "notes_file=$NOTES_FILE" >> "$GITHUB_OUTPUT"
+
+      - name: Create tag
+        if: steps.check.outputs.already_tagged == 'false'
+        env:
+          TAG: ${{ steps.version.outputs.tag }}
+        run: |
+          git config user.name "github-actions[bot]"
+          git config user.email "github-actions[bot]@users.noreply.github.com"
+          git tag -a "$TAG" -m "$TAG"
+          git push origin "$TAG"
+
+      - name: Create GitHub Release
+        if: steps.check.outputs.already_tagged == 'false'
+        env:
+          TAG: ${{ steps.version.outputs.tag }}
+          GH_TOKEN: ${{ github.token }}
+        run: |
+          gh release create "$TAG" \
+            --title "$TAG" \
+            --notes-file "${{ steps.changelog.outputs.notes_file }}"
+
+      - name: Set up Node for npm publish
+        if: steps.check.outputs.already_published == 'false'
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          registry-url: https://registry.npmjs.org
+
+      - name: Publish to npm
+        if: steps.check.outputs.already_published == 'false'
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+        run: npm publish --access public

package/CHANGELOG.md

@@ -5,6 +5,12 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [3.4.3]
+
+### Fixed
+
+- No functional change — validates the automated tag/CHANGELOG/GitHub Release/npm-publish pipeline end-to-end (see #87).
+
 ## [3.4.2]
 
 ### Fixed

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cordova-plugin-ymchat",
-  "version": "3.4.2",
+  "version": "3.4.3",
   "description": "Cordova plugin to integrate yellow.ai chatbot",
   "cordova": {
     "id": "cordova-plugin-ymchat",

package/plugin.xml

@@ -1,5 +1,5 @@
 <?xml version='1.0' encoding='utf-8'?>
-<plugin id="cordova-plugin-ymchat" version="3.4.2"
+<plugin id="cordova-plugin-ymchat" version="3.4.3"
     xmlns="http://apache.org/cordova/ns/plugins/1.0"
     xmlns:android="http://schemas.android.com/apk/res/android">
     <name>ymchat</name>

package/scripts/extract_changelog_section.sh

@@ -0,0 +1,32 @@
+#!/usr/bin/env bash
+# Extracts the CHANGELOG.md section for a given release version (e.g. "3.4.2",
+# no "v" prefix — that's how entries are headed in this repo's Keep a Changelog
+# -style CHANGELOG.md): the category header + bullets between its "## [X.Y.Z]"
+# heading and the next heading, heading itself stripped. This is exactly what
+# goes into the GitHub Release body.
+#
+# Usage: extract_changelog_section.sh <version e.g. 3.4.2> [changelog-file]
+
+set -euo pipefail
+
+VERSION="${1:?usage: extract_changelog_section.sh <version e.g. 3.4.2> [changelog-file]}"
+CHANGELOG="${2:-CHANGELOG.md}"
+
+awk -v ver="$VERSION" '
+  BEGIN { in_section = 0; found = 0; n = 0 }
+  /^## \[[0-9]/ {
+    if (in_section) { exit }
+    if ($0 == "## [" ver "]") { in_section = 1; found = 1; next }
+    next
+  }
+  in_section { n++; buf[n] = $0 }
+  END {
+    if (!found) { exit 1 }
+    # trim trailing blank lines
+    while (n > 0 && buf[n] ~ /^[[:space:]]*$/) { n-- }
+    # trim leading blank lines
+    start = 1
+    while (start <= n && buf[start] ~ /^[[:space:]]*$/) { start++ }
+    for (i = start; i <= n; i++) { print buf[i] }
+  }
+' "$CHANGELOG"

package/scripts/prepare_release.sh

@@ -0,0 +1,191 @@
+#!/usr/bin/env bash
+# Prepares a release on the current feature/fix branch, following this repo's
+# established convention: bump package.json's version, plugin.xml's version
+# attribute (Cordova requires the two to match), optionally the pinned
+# native-SDK dependency (Android and/or iOS) if this release exists to pick
+# up a native SDK change, prepend a Keep-a-Changelog-style CHANGELOG.md
+# entry, and create the single combined commit release PRs have historically
+# carried.
+#
+# This script does NOT tag, create the GitHub Release, or publish to npm —
+# per repo convention, that happens automatically once the PR merges to main
+# (see .github/workflows/release.yml). Run this on your feature branch before
+# opening the PR.
+#
+# Usage:
+#   scripts/prepare_release.sh --bump <patch|minor|major> --category <category> \
+#     [--android-dep vX.Y.Z] [--ios-dep X.Y.Z] "<bullet 1>" ["<bullet 2>" ...]
+#   scripts/prepare_release.sh --version <X.Y.Z> --category <category> ...
+#
+# --category is a Keep a Changelog category: Added, Changed, Deprecated,
+# Removed, Fixed, or Security (or any custom text).
+# --android-dep only touches src/android/build.gradle's YMChatbot-Android
+# pin; --ios-dep only touches plugin.xml's inline <pod name="YMChat"> spec.
+# Omit whichever platform's native SDK didn't change for this release.
+#
+# Example:
+#   scripts/prepare_release.sh --bump patch --category Fixed --ios-dep 2.4.1 \
+#     "Upgraded native iOS SDK to pick up a WebView keyboard-resize fix."
+
+set -euo pipefail
+
+REPO_ROOT="$(cd "$(dirname "${BASH_SOURCE[0]}")/.." && pwd)"
+cd "$REPO_ROOT"
+
+PACKAGE_JSON="package.json"
+PLUGIN_XML="plugin.xml"
+ANDROID_GRADLE="src/android/build.gradle"
+CHANGELOG="CHANGELOG.md"
+INTEGRATION_BRANCH="main"
+
+BUMP=""
+NEW_VERSION=""
+CATEGORY=""
+ANDROID_DEP=""
+IOS_DEP=""
+BULLETS=()
+
+while [[ $# -gt 0 ]]; do
+  case "$1" in
+    --bump) BUMP="$2"; shift 2 ;;
+    --version) NEW_VERSION="$2"; shift 2 ;;
+    --category) CATEGORY="$2"; shift 2 ;;
+    --android-dep) ANDROID_DEP="$2"; shift 2 ;;
+    --ios-dep) IOS_DEP="$2"; shift 2 ;;
+    -h|--help) grep '^#' "$0" | sed 's/^# \{0,1\}//'; exit 0 ;;
+    *) BULLETS+=("$1"); shift ;;
+  esac
+done
+
+if [[ -z "$CATEGORY" || ${#BULLETS[@]} -eq 0 ]]; then
+  echo "error: --category and at least one changelog bullet are required" >&2
+  exit 1
+fi
+
+if [[ -n "$BUMP" && -n "$NEW_VERSION" ]]; then
+  echo "error: pass either --bump or --version, not both" >&2
+  exit 1
+fi
+
+BRANCH="$(git rev-parse --abbrev-ref HEAD)"
+if [[ "$BRANCH" == "$INTEGRATION_BRANCH" ]]; then
+  echo "error: run this on a feature/fix branch, not $INTEGRATION_BRANCH (matches repo convention: the bump+changelog commit lives on the PR branch)" >&2
+  exit 1
+fi
+
+if [[ -n "$(git status --porcelain)" ]]; then
+  echo "error: working tree is not clean; commit or stash your changes first" >&2
+  exit 1
+fi
+
+CURRENT_VERSION="$(sed -n 's/.*"version"[[:space:]]*:[[:space:]]*"\([^"]*\)".*/\1/p' "$PACKAGE_JSON" | head -1)"
+if [[ -z "$CURRENT_VERSION" ]]; then
+  echo "error: could not read current version from $PACKAGE_JSON" >&2
+  exit 1
+fi
+
+if [[ -n "$BUMP" ]]; then
+  IFS='.' read -r MAJOR MINOR PATCH <<< "$CURRENT_VERSION"
+  case "$BUMP" in
+    major) NEW_VERSION="$((MAJOR + 1)).0.0" ;;
+    minor) NEW_VERSION="${MAJOR}.$((MINOR + 1)).0" ;;
+    patch) NEW_VERSION="${MAJOR}.${MINOR}.$((PATCH + 1))" ;;
+    *) echo "error: --bump must be patch, minor, or major" >&2; exit 1 ;;
+  esac
+elif [[ -z "$NEW_VERSION" ]]; then
+  echo "error: pass --bump <patch|minor|major> or --version <X.Y.Z>" >&2
+  exit 1
+fi
+
+if [[ ! "$NEW_VERSION" =~ ^[0-9]+\.[0-9]+\.[0-9]+$ ]]; then
+  echo "error: version must look like X.Y.Z, got: $NEW_VERSION" >&2
+  exit 1
+fi
+
+TAG="v${NEW_VERSION}"
+if git rev-parse -q --verify "refs/tags/$TAG" >/dev/null; then
+  echo "error: tag $TAG already exists" >&2
+  exit 1
+fi
+
+echo "Bumping $CURRENT_VERSION -> $NEW_VERSION ($TAG)"
+
+FILES_TO_COMMIT=("$PACKAGE_JSON" "$PLUGIN_XML" "$CHANGELOG")
+
+# --- 1. Bump package.json version ---
+sed -i.bak "s/\"version\": \"$CURRENT_VERSION\"/\"version\": \"$NEW_VERSION\"/" "$PACKAGE_JSON" && rm -f "$PACKAGE_JSON.bak"
+if ! grep -q "\"version\": \"$NEW_VERSION\"" "$PACKAGE_JSON"; then
+  echo "error: failed to update version in $PACKAGE_JSON" >&2
+  exit 1
+fi
+
+# --- 2. Bump plugin.xml's version attribute (must match package.json) ---
+sed -i.bak "s/<plugin id=\"cordova-plugin-ymchat\" version=\"$CURRENT_VERSION\"/<plugin id=\"cordova-plugin-ymchat\" version=\"$NEW_VERSION\"/" "$PLUGIN_XML" && rm -f "$PLUGIN_XML.bak"
+if ! grep -q "<plugin id=\"cordova-plugin-ymchat\" version=\"$NEW_VERSION\"" "$PLUGIN_XML"; then
+  echo "error: failed to update the version attribute in $PLUGIN_XML" >&2
+  exit 1
+fi
+
+# --- 3. Optionally bump the pinned native-SDK dependencies ---
+if [[ -n "$ANDROID_DEP" ]]; then
+  CURRENT_ANDROID_DEP="$(sed -n "s/.*YMChatbot-Android:\(v[^']*\)'.*/\1/p" "$ANDROID_GRADLE")"
+  sed -i.bak "s/YMChatbot-Android:$CURRENT_ANDROID_DEP'/YMChatbot-Android:$ANDROID_DEP'/" "$ANDROID_GRADLE" && rm -f "$ANDROID_GRADLE.bak"
+  if ! grep -q "YMChatbot-Android:$ANDROID_DEP'" "$ANDROID_GRADLE"; then
+    echo "error: failed to update the YMChatbot-Android pin in $ANDROID_GRADLE" >&2
+    exit 1
+  fi
+  FILES_TO_COMMIT+=("$ANDROID_GRADLE")
+fi
+
+if [[ -n "$IOS_DEP" ]]; then
+  CURRENT_IOS_DEP="$(sed -n 's/.*<pod name="YMChat" spec="~> \([^"]*\)".*/\1/p' "$PLUGIN_XML")"
+  sed -i.bak "s/<pod name=\"YMChat\" spec=\"~> $CURRENT_IOS_DEP\"/<pod name=\"YMChat\" spec=\"~> $IOS_DEP\"/" "$PLUGIN_XML" && rm -f "$PLUGIN_XML.bak"
+  if ! grep -q "<pod name=\"YMChat\" spec=\"~> $IOS_DEP\"" "$PLUGIN_XML"; then
+    echo "error: failed to update the YMChat pod pin in $PLUGIN_XML" >&2
+    exit 1
+  fi
+fi
+
+# --- 4. Prepend CHANGELOG entry (Keep a Changelog style: no date, no link) ---
+ENTRY_FILE="$(mktemp)"
+{
+  echo "## [${NEW_VERSION}]"
+  echo ""
+  echo "### ${CATEGORY}"
+  echo ""
+  for b in "${BULLETS[@]}"; do
+    echo "- ${b}"
+  done
+  echo ""
+} > "$ENTRY_FILE"
+
+# Insert right before the first existing entry (or at EOF if the changelog
+# has none yet).
+awk -v entryfile="$ENTRY_FILE" '
+  inserted { print; next }
+  /^## \[[0-9]/ {
+    while ((getline line < entryfile) > 0) print line
+    inserted = 1
+    print
+    next
+  }
+  { print }
+  END {
+    if (!inserted) {
+      while ((getline line < entryfile) > 0) print line
+    }
+  }
+' "$CHANGELOG" > "$CHANGELOG.new" && mv "$CHANGELOG.new" "$CHANGELOG"
+rm -f "$ENTRY_FILE"
+
+git add "${FILES_TO_COMMIT[@]}"
+
+COMMIT_MSG="Bump version to ${NEW_VERSION}"
+if [[ -n "$ANDROID_DEP" || -n "$IOS_DEP" ]]; then
+  COMMIT_MSG="Bump native SDK deps, update version to ${NEW_VERSION}"
+fi
+git commit -m "$COMMIT_MSG"
+
+echo ""
+echo "Done. Push this branch and open the PR as usual — merging to $INTEGRATION_BRANCH will"
+echo "automatically tag ${TAG}, publish the GitHub Release, and publish to npm."