Skip to content

Commit fa0438b

Browse files
committed
Update CHANGELOG and README to announce deprecation of CocoaPods for Contentstack Swift SDK; recommend Swift Package Manager for new integrations.
1 parent 6ead1c8 commit fa0438b

3 files changed

Lines changed: 58 additions & 0 deletions

File tree

CHANGELOG.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,13 @@
11
# CHANGELOG
22

3+
## v2.3.3
4+
5+
### Date: 02-Apr-2026
6+
7+
### Documentation
8+
9+
- Announced deprecation of **CocoaPods** as the recommended distribution for the Contentstack Swift SDK; **Swift Package Manager** is recommended for new integrations. Updated [README.md](README.md), [Docs/overview.md](Docs/overview.md), and [DEPRECATION.md](DEPRECATION.md).
10+
311
## v2.3.2
412

513
### Date: 12-Jan-2026

DEPRECATION.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# CocoaPods and the Contentstack Swift SDK
2+
3+
This page explains how **CocoaPods** fits into our story for the **Contentstack Swift SDK** (`ContentstackSwift`). It is written for **app developers** integrating the Content Delivery API on Apple platforms.
4+
5+
## Summary
6+
7+
- **The Swift SDK is not deprecated.** This repo continues to ship the supported Swift CDA client.
8+
- We are **deprecating CocoaPods as the recommended way to consume** that SDK. **Swift Package Manager (SPM)** is what we recommend for **new** projects.
9+
- If you already use the pod, you can **keep using it** until you choose to move to SPM.
10+
11+
## What to use
12+
13+
| You want to… | Use this |
14+
|----------------|----------|
15+
| Start a **new** integration | **SPM** — see [Swift Package Index](https://swiftpackageindex.com/contentstack/contentstack-swift) or add `https://github.com/contentstack/contentstack-swift` in Xcode (**File → Add Package Dependencies…**). |
16+
| Read API docs | [Swift Content Delivery SDK reference](https://www.contentstack.com/docs/developers/sdks/content-delivery-sdk/swift/reference) |
17+
| Browse source and tags | [contentstack-swift on GitHub](https://github.com/contentstack/contentstack-swift) |
18+
19+
## Existing CocoaPods users
20+
21+
No forced migration deadline is implied here. Projects that already depend on `ContentstackSwift` via CocoaPods can continue to ship. When you are ready, remove the pod and add the same library through SPM using the GitHub URL above.
22+
23+
## Why SPM for new work
24+
25+
The CocoaPods ecosystem has shifted toward maintenance and archived specs ([CocoaPods Specs repo — industry context](https://blog.cocoapods.org/CocoaPods-Specs-Repo/)). **SPM** is the default for most new Swift and Apple-platform codebases, and it is where we focus **new** documentation and examples. The CocoaPods spec may still receive **maintenance** updates for a time; **SPM should be your first choice** for new apps and modules.
26+
27+
## Help
28+
29+
Questions about the product or your stack: [Contentstack support](https://www.contentstack.com/support).
30+
31+
---
32+
33+
*Last updated: April 2026*

README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,13 @@
33
# Contentstack Swift SDK
44
![Contentstack CI](https://github.com/contentstack/contentstack-swift/workflows/Contentstack%20CI/badge.svg)
55

6+
## Important
7+
8+
This repo is the supported **Contentstack Swift SDK** for the Content Delivery API. **Use Swift Package Manager (SPM) for new projects.** The **`ContentstackSwift`** CocoaPods distribution is **deprecated for new integrations**—prefer SPM. That applies only to **how you install** the SDK, not to Swift or this library.
9+
10+
- **SPM:** [Swift Package Index](https://swiftpackageindex.com/contentstack/contentstack-swift) · [GitHub](https://github.com/contentstack/contentstack-swift)
11+
- **API docs:** [Swift CDA reference](https://www.contentstack.com/docs/developers/sdks/content-delivery-sdk/swift/reference)
12+
- **Background:** [DEPRECATION.md](DEPRECATION.md) · [Docs overview](Docs/overview.md)
613

714
Contentstack is a headless CMS with an API-first approach. It is a CMS that developers can use to build powerful cross-platform applications in their favorite languages. Build your application frontend, and Contentstack will take care of the rest. [Read More](https://www.contentstack.com/).
815

@@ -18,8 +25,18 @@ Latest Xcode and Mac OS X
1825

1926
To use this SDK on iOS platform, you will have to install the SDK according to the steps given below.
2027

28+
##### Swift Package Manager
29+
30+
1. In Xcode: **File → Add Package Dependencies…**
31+
2. Enter `https://github.com/contentstack/contentstack-swift`
32+
3. Add the **ContentstackSwift** product to your target.
33+
34+
See also the [Swift Package Index listing](https://swiftpackageindex.com/contentstack/contentstack-swift).
35+
2136
##### CocoaPods
2237

38+
> **Note:** Not recommended for **new** projects—use **SPM** above. Existing Podfile users can keep the pod; see [DEPRECATION.md](DEPRECATION.md).
39+
2340
1. Add the following line to your Podfile:
2441
2. pod 'ContentstackSwift'
2542
3. Run pod install, and you should now have the latest Contentstack release.

0 commit comments

Comments
 (0)