diff --git a/.changeset/sour-birds-applaud.md b/.changeset/sour-birds-applaud.md new file mode 100644 index 00000000..a8cd40f4 --- /dev/null +++ b/.changeset/sour-birds-applaud.md @@ -0,0 +1,7 @@ +--- +"@react-native-async-storage/async-storage": minor +--- + +Shared Storage artifact published to maven central + +This eliminates the extra step in installation for android. diff --git a/.github/workflows/deploy-docs.yml b/.github/workflows/deploy-docs.yml index 1d5a8a9c..4099006f 100644 --- a/.github/workflows/deploy-docs.yml +++ b/.github/workflows/deploy-docs.yml @@ -47,4 +47,4 @@ jobs: - name: Deploy Docs with mike run: | mike deploy -u -r docs ${{ steps.version.outputs.versionDocs }} latest --push - mike set-default -r docs ${{ steps.version.outputs.versionDocs }} --push + mike set-default -r docs latest --push diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md index 2af56965..4a67f912 100644 --- a/DEVELOPMENT.md +++ b/DEVELOPMENT.md @@ -14,7 +14,8 @@ To build the sdk, run: yarn build:android ``` -The artifact is then moved to `packages/async-storage/android/local_repo` for distribution. +This runs `publishToMavenLocal` and makes the artifact available at `~/.m2`. The example app resolves it from there via +`mavenLocal()`. ### Apple (iOS/macOS) @@ -30,7 +31,8 @@ The artifact is then moved to `packages/async-storage/apple/Frameworks` for dist ## Documentation -Documentation should follow major.minor version of Async Storage. Update the documentation version in root's package.json: +Documentation should follow major.minor version of Async Storage. Update the documentation version in root's +package.json: ```json { @@ -63,4 +65,5 @@ Run `mike deploy` to deploy docs and mark them as latest: ```shell mike deploy -u -r docs --push DOCS_VERSION_FROM_PCK_JSON latest +mike set-default latest -r docs --push ``` diff --git a/README.md b/README.md index bc51b358..1e1ffca0 100644 --- a/README.md +++ b/README.md @@ -46,23 +46,6 @@ npm install @react-native-async-storage/async-storage yarn add @react-native-async-storage/async-storage ``` -### Android - -Inside your `android/build.gradle(.kts)` file, add link to local maven repo: - -```groovy -allprojects { - repositories { - // ... others like google(), mavenCentral() - - maven { - url = uri(project(":react-native-async-storage_async-storage").file("local_repo")) - // or uri("path/to/node_modules/@react-native-async-storage/async-storage/android/local_repo") - } - } -} -``` - ### iOS/macOS Install cocoapods dependencies: diff --git a/docs/migration-to-3.md b/docs/migration-to-3.md index 7ab492b6..44df3703 100644 --- a/docs/migration-to-3.md +++ b/docs/migration-to-3.md @@ -24,23 +24,6 @@ Other components: | ios min target | 13 | | macOS min target | 12 | -### Installation changes - -Android requires a local Maven repository to be added to your `android/build.gradle(.kts)`: - -```groovy -allprojects { - repositories { - // ... others like google(), mavenCentral() - - maven { - url = uri(project(":react-native-async-storage_async-storage").file("local_repo")) - // or uri("path/to/node_modules/@react-native-async-storage/async-storage/android/local_repo") - } - } -} -``` - ### `AsyncStorage` is now instance-based In v3, AsyncStorage is no longer a singleton. diff --git a/package.json b/package.json index 68617413..fa7b1fc7 100644 --- a/package.json +++ b/package.json @@ -2,7 +2,7 @@ "private": true, "name": "@react-native-async-storage/root", "version": "0.0.1-dev", - "versionDocs": "3.0", + "versionDocs": "3.1", "scripts": { "build": "turbo run build", "build:android": "./scripts/build-native-lib.sh android", diff --git a/packages/async-storage/android/gradle.properties b/packages/async-storage/android/gradle.properties index b48a786e..87fedffb 100644 --- a/packages/async-storage/android/gradle.properties +++ b/packages/async-storage/android/gradle.properties @@ -3,4 +3,4 @@ AsyncStorage_roomVersion=2.7.2 AsyncStorage_minSdkVersion=24 AsyncStorage_targetSdkVersion=36 AsyncStorage_compileSdkVersion=36 -AsyncStorage_sharedStorageVersion=0.0.1 \ No newline at end of file +AsyncStorage_sharedStorageVersion=1.0.0 \ No newline at end of file diff --git a/packages/expo-with-async-storage/README.md b/packages/expo-with-async-storage/README.md index 262f0214..503de973 100644 --- a/packages/expo-with-async-storage/README.md +++ b/packages/expo-with-async-storage/README.md @@ -2,6 +2,12 @@ title: Expo config plugin --- +!!! warning "No longer required for version 3.1.0+" + + This plugin originally was intended to include locally build artifact for Android. + With version 3.1.0 of Async Storage, this artifact is provided via Maven Central (no extra steps needed). + + # Expo config plugin for Async Storage An [Expo config plugin](https://docs.expo.dev/config-plugins/introduction/) that automatically configures