Skip to content

Commit ea88768

Browse files
authored
docs: remove v10 and old architecture references (#4160)
v10 and old architecture are no longer supported. Update all docs, issue templates, and CI to reflect v11-only and New Architecture.
1 parent 4307fb5 commit ea88768

File tree

10 files changed

+30
-151
lines changed

10 files changed

+30
-151
lines changed

.github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 6 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -10,35 +10,19 @@ body:
1010
1111
---
1212
13-
⚠️ **Deprecation Notice** ⚠️
14-
15-
**v10.x and old architecture (Paper/bridge) issues are deprecated and will not receive attention.**
16-
17-
Please upgrade to v11+ with new architecture (Fabric/TurboModules) for active support.
13+
**Requirements:** This library requires Mapbox Maps SDK v11 and React Native 0.79+ with New Architecture (Fabric/TurboModules).
1814
1915
**For sponsors-only support and resources:** https://github.com/rnmapbox/maps/wiki/SponsorsRepo
2016
**Become a sponsor for special support:** https://github.com/sponsors/rnmapbox
2117
2218
---
23-
- type: dropdown
24-
id: mapbox-implementation
25-
attributes:
26-
label: Mapbox Implementation
27-
description: |-
28-
Check `RNMapboxMapsImpl` in your Podfile/gradle files. Defaults to `Maplibre`.
29-
options:
30-
- Mapbox
31-
- Mapbox GL
32-
- Maplibre
33-
validations:
34-
required: true
3519
- type: input
3620
id: mapbox-version
3721
attributes:
3822
label: Mapbox Version
3923
description: |-
40-
Check `RNMapboxMapsVersion` in your Podfile/gradle files, set to `default` if you don't cusomize the version
41-
placeholder: 10.7.0
24+
Check `RNMapboxMapsVersion` in your Podfile/gradle files, set to `default` if you don't customize the version
25+
placeholder: 11.16.2
4226
validations:
4327
required: true
4428
- type: input
@@ -47,18 +31,7 @@ body:
4731
label: React Native Version
4832
description: |-
4933
The React Native version
50-
placeholder: 0.73.2
51-
validations:
52-
required: true
53-
- type: dropdown
54-
id: react-native-architecture
55-
attributes:
56-
label: React Native Architecture
57-
description: |-
58-
Select the React Native architecture you're using
59-
options:
60-
- New Architecture (Fabric/TurboModules)
61-
- Old Architecture (Paper/bridge)
34+
placeholder: 0.79.0
6235
validations:
6336
required: true
6437
- type: dropdown
@@ -78,8 +51,8 @@ body:
7851
attributes:
7952
label: "`@rnmapbox/maps` version"
8053
description: |-
81-
The version of `@rnmapbox/maps`, such as `#main`, `10.0.0-beta.32`
82-
value: 10.0.0-beta.11
54+
The version of `@rnmapbox/maps`
55+
placeholder: 10.3.0
8356
validations:
8457
required: true
8558
- type: textarea

.github/ISSUE_TEMPLATE/bug_setup.md

Lines changed: 7 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,7 @@ labels: 'bug-setup 🪲'
55
assignees: ''
66
---
77

8-
⚠️ **Deprecation Notice** ⚠️
9-
10-
**v10.x and old architecture (Paper/bridge) issues are deprecated and will not receive attention.**
11-
12-
Please upgrade to v11+ with new architecture (Fabric/TurboModules) for active support.
8+
**Requirements:** This library requires Mapbox Maps SDK v11 and React Native 0.79+ with New Architecture (Fabric/TurboModules).
139

1410
**For sponsors-only support and resources:** https://github.com/rnmapbox/maps/wiki/SponsorsRepo
1511
**Become a sponsor for special support:** https://github.com/sponsors/rnmapbox
@@ -18,21 +14,19 @@ Please upgrade to v11+ with new architecture (Fabric/TurboModules) for active su
1814

1915
## Environment
2016
- Dev OS: [e.g. OSX 11.0.1, Win10]
21-
- @rnmapbox/maps version: [eg. 10.0.15]
22-
- React Native version: [eg. 0.72.6]
23-
- React Native Architecture: [New Architecture (Fabric/TurboModules) / Old Architecture (Paper/bridge)]
24-
- Expo version: [eg. 49.0.0]
17+
- @rnmapbox/maps version: [eg. 10.3.0]
18+
- React Native version: [eg. 0.79.0]
19+
- Expo version: [eg. 54.0.0]
2520

2621

2722
## Steps to reproduce
2823

2924
<!--- We don't troubleshoot existing projects, please reproduce the issue in a brand new project. If you can't then create a new working project and compare with the one you're having trouble with. --->
3025

3126
```sh
32-
react-native init sample --version react-native@0.60.5
27+
npx @react-native-community/cli init sample
3328
cd sample
34-
npm install rnmapbox/maps#main --save
35-
# or released version `npm install @rnmapbox/maps@8.0.0-rc1 --save`
36-
react-native run-android
29+
npm install @rnmapbox/maps --save
30+
npx react-native run-android
3731
```
3832

.github/workflows/bump-version.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -36,14 +36,14 @@ jobs:
3636
# run that runs on: tag. (Using the GitHub token would
3737
# not run the workflow to prevent infinite recursion.)
3838
- name: Check out source
39-
uses: actions/checkout@v3
39+
uses: actions/checkout@v4
4040
with:
4141
ssh-key: ${{ secrets.DEPLOY_KEY }}
4242

4343
- name: Setup Node.js
44-
uses: actions/setup-node@v3.5.1
44+
uses: actions/setup-node@v4
4545
with:
46-
node-version: '16'
46+
node-version: '22'
4747

4848
- name: Setup Git
4949
run: |

AGENTS.md

Lines changed: 3 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -61,25 +61,7 @@ yarn generate
6161

6262
### Building for Different Configurations
6363

64-
#### Mapbox v10 - deprecated
65-
```bash
66-
# iOS
67-
cd example/ios
68-
RNMBX10=1 pod update MapboxMaps
69-
70-
# Android
71-
# Edit example/android/gradle.properties: RNMBX10=true
72-
```
73-
74-
#### New Architecture/Fabric
75-
```bash
76-
# iOS
77-
cd example/ios
78-
RCT_NEW_ARCH_ENABLED=1 pod update MapboxMaps
79-
80-
# Android
81-
# Edit example/android/gradle.properties: newArchEnabled=true
82-
```
64+
The project uses Mapbox Maps SDK v11 and React Native's New Architecture (Fabric/TurboModules) exclusively.
8365

8466
## Architecture Overview
8567

@@ -91,7 +73,7 @@ RCT_NEW_ARCH_ENABLED=1 pod update MapboxMaps
9173
- Each component extends either `AbstractLayer` or `AbstractSource` for common functionality
9274

9375
### Native Bridge
94-
- **Specs** (`src/specs/`): TurboModule/Fabric component specs for new architecture
76+
- **Specs** (`src/specs/`): TurboModule/Fabric component specs
9577
- **Native Components**: Each component has corresponding native implementations:
9678
- iOS: `ios/RNMBX/RNMBX*.swift` and `RNMBX*ComponentView.mm`
9779
- Android: `android/src/main/java/` (generated from specs)
@@ -143,4 +125,4 @@ RCT_NEW_ARCH_ENABLED=1 pod update MapboxMaps
143125
- The example app is the primary way to test changes
144126
- Native changes require rebuilding the app
145127
- Web support is experimental and may have limited functionality
146-
- Support both old and new React Native architectures
128+
- Requires React Native 0.79+ with New Architecture (Fabric/TurboModules)

CONTRIBUTING.md

Lines changed: 2 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -16,18 +16,7 @@ Some notes about example app:
1616

1717
### Example app configurations:
1818

19-
- V10: this build with V10 of mapbox
20-
To build example in this mode on ios run:
21-
```
22-
cd example/ios ; RNMBX10=1 pod update MapboxMaps
23-
```
24-
To build example in this mode on android:
25-
Change `RNMBX10=true` in `example/android/gradle.properties`
26-
- NewArchitecture/Fabric:
27-
```
28-
cd example/ios ; RCT_NEW_ARCH_ENABLED=1 pod update MapboxMaps
29-
```
30-
On android change `newArchEnabled=true` in `example/android/gradle.properties`
19+
The project uses Mapbox Maps SDK v11 and React Native's New Architecture (Fabric/TurboModules) exclusively.
3120

3221
### Running example app for Web
3322

@@ -49,7 +38,7 @@ Run `yarn generate` to update generated code/documentation.
4938
We use the following code generators, but check yarn generate for more:
5039
- `style-spec/v8.json` download from mapbox.com describes properties of layers/sources etc. We generate the following files from it:
5140
- `MapboxStyles.d.ts` - typescript definitions for different Layer styles
52-
- `RNMBXStyle.swift.ejs`/`RNMBXStyleFactoryV10.kt` - ios/android native style setters
41+
- `RNMBXStyle.swift.ejs`/`RNMBXStyleFactory.kt` - ios/android native style setters
5342
- `docs.json` is generated both from style-spec and documentation in our typescript files
5443
- Document generation:
5544
- `docs/MapView.md` is generated from `src/components/MapView.tsx` with `react-docgen`

README.md

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -56,11 +56,8 @@ _A community-supported, open-source React Native library for building maps with
5656

5757
---
5858

59-
### Supported Implementations
60-
At the moment we support Mapbox (v10) and Mapbox (v11) beta.
61-
We default to Mapbox (v10).
62-
63-
_See [iOS](ios/install.md) & [Android](android/install.md) setup guide for using v11 beta_
59+
### Supported Implementations
60+
We support Mapbox Maps SDK v11. See [iOS](ios/install.md) & [Android](android/install.md) setup guides.
6461

6562

6663

@@ -74,7 +71,7 @@ _See [iOS](ios/install.md) & [Android](android/install.md) setup guide for using
7471

7572
- [node](https://nodejs.org)
7673
- [npm](https://www.npmjs.com/)
77-
- [React Native](https://facebook.github.io/react-native/) (0.70+, older versions from 0.64+ might or might not work)
74+
- [React Native](https://facebook.github.io/react-native/) (0.79+)
7875

7976

8077
## Installation

android/install.md

Lines changed: 3 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,7 @@
22

33
## Supported mapbox libraries
44

5-
We're only supporting mapbox 10.16* and 11.*. The default is 10.16*.
6-
Next release will be 11.* only so we recommend updatign to 11.*
5+
We support Mapbox Maps SDK v11.
76

87
### Adding mapbox maven repo
98

@@ -27,39 +26,14 @@ allprojects {
2726

2827
### Using non default mapbox version
2928

30-
*Warning*: If you set a custom version, make sure you revisit, any time you update @rnmapbox/maps. Setting it to earlier version than what we exepect will likely result in a build error.
29+
*Warning*: If you set a custom version, make sure you revisit any time you update @rnmapbox/maps. Setting it to an earlier version than what we expect will likely result in a build error.
3130

3231
Set `RNMapboxMapsVersion` in `android/build.gradle > buildscript > ext` section
3332

34-
35-
```groovy
36-
buildscript {
37-
ext {
38-
RNMapboxMapsVersion = '11.4.1'
39-
}
40-
}
41-
```
42-
43-
you can also customize all the libraries, should it be neccesary
44-
45-
```groovy
46-
buildscript {
47-
ext {
48-
// ...
49-
RNMapboxMapsLibs = { // optional - only required if you want to customize it
50-
implementation 'com.mapbox.maps:android:10.6.0'
51-
implementation 'com.mapbox.mapboxsdk:mapbox-sdk-turf:5.4.1'
52-
}
53-
}
54-
}
55-
```
56-
57-
### Using v11
58-
5933
```groovy
6034
buildscript {
6135
ext {
62-
RNMapboxMapsVersion = '11.4.1'
36+
RNMapboxMapsVersion = '11.16.2'
6337
}
6438
}
6539
```

ios/RNMBX/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
iOS v10 code
1+
iOS native code

ios/install.md

Lines changed: 2 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -50,23 +50,10 @@ Read on if you want to edit your Mapbox version or flavor.
5050

5151
## Using a custom version of the Mapbox SDK
5252

53-
You can also override the version to use. *Warning:* if you set a version, then later update, the `rnamapbox/maps` library it's possible that you'll end up using Mapbox older version than supported. Make sure you revise this value with `@rnmapbox/maps` updates. Also note that for 11.0 or later versions you'll need to set `$RNMapboxMapsUseV11 = true`, see bellow
53+
You can override the version to use. *Warning:* if you set a version, then later update the `@rnmapbox/maps` library it's possible that you'll end up using an older Mapbox version than supported. Make sure you revise this value with `@rnmapbox/maps` updates.
5454

5555
```ruby
56-
# Warning: only for advanced use cases, only do this if you know what you're doing.
57-
# $RNMapboxMapsVersion = '~> 10.16.2'
58-
```
59-
60-
<br/>
61-
62-
## V11 support
63-
64-
We have support for mapbox 11.
65-
66-
Add the following to your Podfile:
67-
68-
```ruby
69-
$RNMapboxMapsVersion = '= 11.13.4'
56+
$RNMapboxMapsVersion = '= 11.16.2'
7057
```
7158

7259
If using expo managed workflow, set the "RNMapboxMapsVersion" variable. See the [expo guide](/plugin/install.md)

plugin/install.md

Lines changed: 0 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -66,23 +66,6 @@ It's possible to overwrite the native SDK version with `RNMapboxMapsVersion`:
6666
}
6767
```
6868

69-
To use V11 just set the version to a 11 version, see [the ios guide](/ios/install.md):
70-
71-
```json
72-
{
73-
"expo": {
74-
"plugins": [
75-
[
76-
"@rnmapbox/maps",
77-
{
78-
"RNMapboxMapsVersion": "11.13.4"
79-
}
80-
]
81-
]
82-
}
83-
}
84-
```
85-
8669
## Manual Setup
8770

8871
For bare workflow projects, you can follow the manual setup guides:

0 commit comments

Comments
 (0)