Skip to content

Commit ed0d4aa

Browse files
chore: deprecation notice and eol (#222)
1 parent 674dd63 commit ed0d4aa

File tree

5 files changed

+23
-3
lines changed

5 files changed

+23
-3
lines changed

.github/workflows/push-docker-releases.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,8 @@ jobs:
2424
type=semver,pattern={{major}}.{{minor}}
2525
type=semver,pattern={{major}}
2626
type=sha
27+
labels: |
28+
org.opencontainers.image.description='DEPRECATED: unleashorg/unleash-proxy is deprecated. Support ends on 2026-11-26. Migrate to Unleash Edge: https://github.com/Unleash/unleash-edge'
2729
- name: Set up QEMU
2830
uses: docker/setup-qemu-action@v3
2931
with:

.github/workflows/push-ecr-releases.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,8 @@ jobs:
4545
type=semver,pattern={{major}}.{{minor}}
4646
type=semver,pattern={{major}}
4747
type=sha
48+
labels: |
49+
org.opencontainers.image.description='DEPRECATED: unleashorg/unleash-proxy is deprecated. Support ends on 2026-11-26. Migrate to Unleash Edge: https://github.com/Unleash/unleash-edge'
4850
- name: Set up QEMU
4951
uses: docker/setup-qemu-action@v3
5052
with:

.github/workflows/release.yml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,3 +33,9 @@ jobs:
3333
npm publish --tag ${TAG:-latest}
3434
env:
3535
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
36+
- name: Mark package as deprecated on npm
37+
run: |
38+
VERSION="${GITHUB_REF_NAME#v}"
39+
npm deprecate "@unleash/proxy@<=${VERSION}" "DEPRECATED: unleashorg/unleash-proxy is deprecated. Support ends on 2026-11-26. Migrate to Unleash Edge: https://github.com/Unleash/unleash-edge"
40+
env:
41+
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

README.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,19 @@
1-
![Maintenance Mode](https://img.shields.io/badge/status-maintenance-orange)
1+
![Deprecated](https://img.shields.io/badge/status-deprecated-red)
22

3-
**This project is in maintenance mode. No new features will be added and we will only do security patches in this repository going forward. Use [Unleash Edge](https://github.com/unleash/unleash-edge) instead.**
3+
**This project is deprecated. Use [Unleash Edge](https://github.com/unleash/unleash-edge) instead.**
44

55
[![Build & Tests](https://github.com/Unleash/unleash-proxy/workflows/Node.js%20CI/badge.svg?branch=main)](https://github.com/Unleash/unleash-proxy/actions/workflows/node.js.yml) [![npm](https://img.shields.io/npm/v/@unleash/proxy)](https://www.npmjs.com/package/@unleash/proxy) [![Docker Pulls](https://img.shields.io/docker/pulls/unleashorg/unleash-proxy)](https://hub.docker.com/r/unleashorg/unleash-proxy)
66

7+
## Lifecycle status
8+
9+
| Date | Status | Details |
10+
| --- | --- | --- |
11+
| 2023-09-06 | Soft deprecation | README updated to recommend Unleash Edge (`docs: add note to consider Edge instead`, commit `2e73af5`). |
12+
| 2024-11-26 | Maintenance mode | README updated to security fixes only (`docs: add maintenance mode`, commit `2883a83`). |
13+
| 2026-11-26 | End of life (planned) | Support ends for this package and published Docker images. No additional releases are planned after this date. |
14+
15+
Until EOL, this repository only accepts security and critical bug fixes.
16+
717
# The Unleash Proxy
818

919
The Unleash proxy offers a way to use Unleash in client-side applications, such as single-page and native apps. The Unleash proxy sits between the Unleash API and your client-side SDK and does the evaluation of feature toggles for your client-side SDK. This way, you can keep your configuration private and secure, while still allowing your client-side apps to use Unleash's features.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@unleash/proxy",
3-
"version": "1.4.14",
3+
"version": "1.4.16",
44
"description": "The Unleash Proxy (Open-Source)",
55
"main": "dist/index.js",
66
"types": "dist/index.d.ts",

0 commit comments

Comments
 (0)