Skip to content

Release v5.0.0-beta.1 #1179

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 14, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
66 changes: 66 additions & 0 deletions MIGRATION_GUIDE.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,71 @@
# Migration Guide

## Upgrading from v4 -> v5

### Compatibility Requirements

- **React**: v5 requires React 19 or higher
- **React Native**: v5 requires React Native 0.78.0 or higher
- **Expo**: v5 requires Expo 53 or higher

### Breaking Changes

- **Platform Compatibility**: The minimum iOS deployment target is now 14.0. Update your iOS/Podfile with:

```
platform :ios, '14.0'
```

- **Android Requirements**: Android SDK API level 35 or higher is now required

### Migration Steps

#### For Regular React Native Projects

1. First, ensure your project uses React 19 and React Native 0.78.0 or higher:

```bash
npm install react@^19.0.0
npm install react-native@^0.78.0
```

2. Update the react-native-auth0 package:

```bash
npm install react-native-auth0@beta
```

3. Update your iOS minimum deployment target in your Podfile:

```ruby
platform :ios, '14.0'
```

4. Install the updated pods:
```bash
cd ios && pod install && cd ..
```

#### For Expo Projects

1. Update to Expo 53 or higher:

```bash
npx expo upgrade
```

2. Update the react-native-auth0 package:

```bash
npm install react-native-auth0@beta
```

3. Rebuild your app:
```bash
npx expo prebuild --clean
```
Note: This will reset any manual changes to your native code.

## Upgrading from v3 -> v4

- **If your project is built with Expo:**
Expand Down
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,13 @@

📚 [Documentation](#documentation) • 🚀 [Getting Started](#getting-started) • ⏭️ [Next Steps](#next-steps) • ❓ [FAQs](https://github.com/auth0/react-native-auth0/blob/master/FAQ.md) • ❓ [Feedback](#feedback)

### ⚠️ Important Migration Notice: v4.0.0
### ⚠️ Important Migration Notice: v4.0.0 and v5.0.0beta

We're excited to announce the release of react-native-auth0 `v4.0.0`! Please note that this update includes breaking changes that require your attention. To ensure a smooth transition, please review our
👉 [Migration Guide](https://github.com/auth0/react-native-auth0/blob/master/MIGRATION_GUIDE.md) 👈 for detailed instructions on updating your integration.
We're excited to announce the release of react-native-auth0 `v4.0.0` and the beta release of `v5.0.0`!

**For v4.0.0 users:** Please note that this update includes breaking changes that require your attention. To ensure a smooth transition, please review our 👉 [Migration Guide](https://github.com/auth0/react-native-auth0/blob/master/MIGRATION_GUIDE.md) 👈 for detailed instructions on updating your integration.

**For v5.0.0beta users:** This beta version requires React 19 and React Native 0.78.0 or higher. If you're using Expo, this version requires Expo 53 or higher. See the 👉 [Migration Guide](https://github.com/auth0/react-native-auth0/blob/beta/MIGRATION_GUIDE.md) 👈 for compatibility requirements and upgrade instructions.

## Documentation

Expand Down