polarity-integration-utils 2.0.8 → 2.0.9

package/README.md

@@ -33,5 +33,25 @@ Documentation for this library can be found at: https://polarityio.github.io/pol
     npm run docs
 
 ### Continuous Integration
-All pull-requests run the same **build → lint → test** pipeline in GitHub Actions.  
-Ensure local runs are green before opening a PR.
+
+All pull requests run automated linting and tests (with coverage) via GitHub Actions. Ensure local runs are green before opening a PR.
+
+#### PR Checks
+
+Pull requests targeting `develop`, `main`, or any `support/*` branch trigger the shared build workflow which runs linting, tests with coverage, and uploads results to Codecov.
+
+#### Release (main branch)
+
+Pushes to `main` trigger the full release workflow:
+
+1. **Build & test** — runs the shared build pipeline.
+2. **Release** — creates a GitHub Release tagged with the package version (e.g., `v3.1.6`), marks it as the latest release, and publishes to npm under the `latest` dist-tag.
+3. **Deploy docs** — after a successful release, builds TypeDoc documentation and deploys to GitHub Pages.
+
+#### Release (support branches)
+
+Pushes to `support/*` branches (e.g., `support/1.0`, `support/2.0`) trigger the same release workflow with the following differences:
+
+- **Docs are not deployed** — only `main` publishes documentation to GitHub Pages.
+- **GitHub Release is not marked as latest** — the release is still created with the full version tag (e.g., `v2.0.9`) but will not appear as the "Latest" release in the GitHub UI.
+- **npm publish uses a version-specific dist-tag** — instead of `latest`, support branches publish under `v{major}-latest` (e.g., `v2-latest`, `v1-latest`). This ensures `npm install polarity-integration-utils` continues to resolve to the current major version while older versions remain installable via their dist-tag (e.g., `npm install polarity-integration-utils@v2-latest`).

package/dist/tsdoc-metadata.json

@@ -5,7 +5,7 @@
   "toolPackages": [
     {
       "packageName": "@microsoft/api-extractor",
-      "packageVersion": "7.52.13"
+      "packageVersion": "7.57.6"
     }
   ]
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "polarity-integration-utils",
-  "version": "2.0.8",
+  "version": "2.0.9",
   "description": "A utility library for building Polarity Integrations",
   "files": [
     "dist"
@@ -61,31 +61,31 @@
   "author": "Polarity IO <support@polarity.io>",
   "license": "MIT",
   "bugs": {
-    "url": "https://github.com/polarity-integration-utils/polarity-integration-utils/issues"
+    "url": "https://github.com/polarityio/polarity-integration-utils/issues"
   },
-  "homepage": "https://github.com/polarity-integration-utils/polarity-integration-utils#readme",
+  "homepage": "https://github.com/polarityio/polarity-integration-utils#readme",
   "devDependencies": {
     "@eslint/js": "^9.36.0",
-    "@microsoft/api-extractor": "^7.52.13",
+    "@microsoft/api-extractor": "^7.57.6",
     "@types/jest": "^30.0.0",
     "@types/lodash": "^4.17.20",
     "@types/node": "^20.14.8",
-    "@typescript-eslint/eslint-plugin": "^8.44.0",
-    "@typescript-eslint/parser": "^8.44.0",
+    "@typescript-eslint/eslint-plugin": "^8.56.1",
+    "@typescript-eslint/parser": "^8.56.1",
     "copy-paste": "^2.2.0",
-    "eslint": "^9.36.0",
+    "eslint": "^9.39.4",
     "eslint-plugin-tsdoc": "^0.4.0",
     "globals": "^16.4.0",
-    "jest": "^30.1.3",
-    "ts-jest": "^29.4.4",
-    "typedoc": "^0.28.13",
+    "jest": "^30.2.0",
+    "ts-jest": "^29.4.6",
+    "typedoc": "^0.28.17",
     "typescript": "^5.9.2",
-    "typescript-eslint": "^8.44.0"
+    "typescript-eslint": "^8.56.1"
   },
   "dependencies": {
     "bottleneck": "^2.19.5",
-    "lodash": "^4.17.21",
-    "postman-request": "^2.88.1-postman.43"
+    "lodash": "^4.17.23",
+    "postman-request": "^2.88.1-postman.48"
   },
   "sideEffects": false
 }