From df2136efff6ed1e43451a88200614a4ea3ec0adc Mon Sep 17 00:00:00 2001 From: Sai Kumar Battinoju Date: Tue, 28 Jan 2025 11:46:57 +0530 Subject: [PATCH] feat: add legacy sdk deprecation notices --- .github/workflows/deploy-npm.yml | 10 ++++++++++ packages/analytics-v1.1/README.md | 4 ++-- packages/analytics-v1.1/package.json | 3 ++- packages/analytics-v1.1/src/core/analytics.js | 6 ++++++ 4 files changed, 20 insertions(+), 3 deletions(-) diff --git a/.github/workflows/deploy-npm.yml b/.github/workflows/deploy-npm.yml index aabd3a98e..fdf023cb9 100644 --- a/.github/workflows/deploy-npm.yml +++ b/.github/workflows/deploy-npm.yml @@ -141,6 +141,16 @@ jobs: echo "CURRENT_NPM_VERSION_COOKIE_UTILS=${{ env.CURRENT_NPM_VERSION_COOKIE_UTILS }}" echo "NEW_NPM_VERSION_COOKIE_UTILS=${{ env.NEW_NPM_VERSION_COOKIE_UTILS }}" + - name: Deprecate the legacy SDK NPM package + continue-on-error: true + env: + NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }} + NPM_CONFIG_PROVENANCE: true + run: | + npm set //registry.npmjs.org/:_authToken=${{ secrets.NPM_TOKEN }} + + npm deprecate rudder-sdk-js "This package is deprecated and no longer maintained. Please migrate to the latest package, @rudderstack/analytics-js (https://www.npmjs.com/package/@rudderstack/analytics-js), for the latest features, security updates, and improved performance. For more details, visit: https://www.rudderstack.com/docs/sources/event-streams/sdks/rudderstack-javascript-sdk/migration-guide/." + - name: Send message to Slack channel if: env.CURRENT_NPM_VERSION != env.NEW_NPM_VERSION && env.NEW_NPM_VERSION != 'not found' id: slack diff --git a/packages/analytics-v1.1/README.md b/packages/analytics-v1.1/README.md index 54c77c695..62144e7e9 100644 --- a/packages/analytics-v1.1/README.md +++ b/packages/analytics-v1.1/README.md @@ -19,8 +19,8 @@ --- -| :warning: This package is deprecated. Please switch to the latest [@rudderstack/analytics-js](https://www.npmjs.com/package/@rudderstack/analytics-js) package for improved features and support.
For more details, visit [link](https://www.rudderstack.com/docs/sources/event-streams/sdks/rudderstack-javascript-sdk/). | -| :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| :warning: **This package is deprecated and no longer maintained.** Please migrate to the latest [@rudderstack/analytics-js](https://www.npmjs.com/package/@rudderstack/analytics-js) package for enhanced features, security updates, and ongoing support.

For more details, visit the [official documentation](https://www.rudderstack.com/docs/sources/event-streams/sdks/rudderstack-javascript-sdk/). | +| :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | # RudderStack JavaScript SDK diff --git a/packages/analytics-v1.1/package.json b/packages/analytics-v1.1/package.json index 5b16ba004..af0db15ef 100644 --- a/packages/analytics-v1.1/package.json +++ b/packages/analytics-v1.1/package.json @@ -64,7 +64,8 @@ "build:browser:modern:bundle-size": "VISUALIZER=true npm run build:browser:modern", "build:npm:dev": "rollup --config rollup-configs/rollup.sdk.npm.mjs --environment VERSION:$npm_package_version,NPM", "package": "npm pack", - "release": "npm publish" + "release": "npm publish", + "postinstall": "echo 'This package is deprecated and no longer maintained. Please migrate to the latest @rudderstack/analytics-js (https://www.npmjs.com/package/@rudderstack/analytics-js) package for enhanced features, security updates, and ongoing support. For more details, visit the official documentation: https://www.rudderstack.com/docs/sources/event-streams/sdks/rudderstack-javascript-sdk/.'" }, "keywords": [ "analytics", diff --git a/packages/analytics-v1.1/src/core/analytics.js b/packages/analytics-v1.1/src/core/analytics.js index 29aff3b03..2108c2601 100644 --- a/packages/analytics-v1.1/src/core/analytics.js +++ b/packages/analytics-v1.1/src/core/analytics.js @@ -1658,6 +1658,12 @@ const startSession = instance.startSession.bind(instance); const endSession = instance.endSession.bind(instance); const setAuthToken = instance.setAuthToken.bind(instance); +if ('__MODULE_TYPE__' === 'npm') { + logger.error('This package is deprecated and no longer maintained. Please migrate to the latest [@rudderstack/analytics-js](https://www.npmjs.com/package/@rudderstack/analytics-js) package for enhanced features, security updates, and ongoing support. For more details, visit the official documentation: https://www.rudderstack.com/docs/sources/event-streams/sdks/rudderstack-javascript-sdk/.'); +} else { + logger.error('This version of the RudderStack JavaScript SDK is deprecated and no longer maintained. Please migrate to the latest version (v3) for enhanced features, security updates, and ongoing support. For more details, visit the official documentation: https://www.rudderstack.com/docs/sources/event-streams/sdks/rudderstack-javascript-sdk/.'); +} + export { initialized, ready,