From 39b50f36a6cbc8102d14046ca28a9d81ebcab59c Mon Sep 17 00:00:00 2001 From: reeshika-h Date: Thu, 9 Apr 2026 16:11:38 +0530 Subject: [PATCH] Update CHANGELOG and README to reflect deprecation of Contentstack Utils Dart package and provide migration guidance to Content Delivery API. --- CHANGELOG.md | 8 +++++++- DEPRECATION.md | 27 +++++++++++++++++++++++++++ README.md | 8 +++++++- 3 files changed, 41 insertions(+), 2 deletions(-) create mode 100644 DEPRECATION.md diff --git a/CHANGELOG.md b/CHANGELOG.md index 9f8c574..1b68236 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,4 +1,10 @@ -# Changelog +# CHANGELOG + +### **APR-09-2026** + +#### Documentation + +- Add deprecation notice and migration guidance to the Content Delivery API. See [DEPRECATION.md](DEPRECATION.md). ## v1.1.1 diff --git a/DEPRECATION.md b/DEPRECATION.md new file mode 100644 index 0000000..a55d8b3 --- /dev/null +++ b/DEPRECATION.md @@ -0,0 +1,27 @@ +# Deprecation notice: Contentstack Dart Utils (pub.dev) + +This page is for **developers using the Contentstack Dart Utils** package published on **pub.dev** as [`contentstack_utils`](https://pub.dev/packages/contentstack_utils). + +## What this means for you + +**We are deprecating this package as the recommended path for new Dart and Flutter work.** If you are **starting a new project**, use our **[Content Delivery API (CDA)](https://www.contentstack.com/docs/developers/apis/content-delivery-api/)** and implement rich text / JSON RTE handling in your app using current product documentation. + +**If you already ship an app** that depends on `contentstack_utils`, you can **keep using it**. Your integration continues to work. Plan migration when it fits your release schedule—you do not have to change immediately. + +The **[Contentstack Dart SDK](https://github.com/contentstack/contentstack-dart)** is deprecated on the same timeline; see that repository’s **DEPRECATION.md**. + +## What to use for new projects + +| | Link | +|---|------| +| **Content Delivery API** | [Content Delivery API documentation](https://www.contentstack.com/docs/developers/apis/content-delivery-api/) | + +## Why we are making this change + +We are focusing investment on **direct API usage** and **documented integration patterns** for Dart and Flutter. This repository will remain in **maintenance**: we may address critical or security issues where we can, but **we do not plan new features** in this package. + +## Support for this package going forward + +This repository will stay in **maintenance** as described above. Feature work and new capabilities should be built against the **Content Delivery API** and your application code. + +If you need help choosing a migration path or timing, contact **[Contentstack support](https://www.contentstack.com/)** or your account team. diff --git a/README.md b/README.md index 68fb010..c0e15ef 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,10 @@ -# A Contentstack-Utils library for Dart developers +# ![Contentstack](https://www.contentstack.com/docs/static/images/contentstack.png) + +## Important: Dart Utils and pub.dev + +**We are deprecating** the **Contentstack Utils** Dart package on pub.dev as the supported path for **new** development. **New Dart or Flutter projects should use the [Content Delivery API](https://www.contentstack.com/docs/developers/apis/content-delivery-api/)** and your own handling for rich text / JSON RTE, following current documentation. + +**Already using this package?** You can keep shipping with your current dependencies and migrate when it makes sense for your app. More detail: **[DEPRECATION.md](DEPRECATION.md)**. ![Coverage](https://github.com/contentstack/contentstack-utils-dart/blob/master/coverage_badge.svg?sanitize=true)