Async Storage v3

.changeset/config.json

@@ -9,9 +9,8 @@
   "updateInternalDependencies": "patch",
   "ignore": [
     "@react-native-async-storage/eslint-config",
-    "async-storage-website",
-    "@react-native-async-storage/api",
-    "@react-native-async-storage/sqlite-storage",
-    "react-native-example-sqlitestorage"
+    "example-react-native",
+    "example-web",
+    "example-common-tests"
   ]
 }

.github/CONTRIBUTING.md

@@ -1,22 +1,18 @@
 # Contributing to React Native Async Storage
 
 Thank you for helping out with Async Storage! We'd like to make contributions as
-pleasent as possible, so here's a small guide of how we see it. Happy to hear
+pleasant as possible, so here's a small guide of how we see it. Happy to hear
 your feedback about anything, so please let us know.
 
 ## Tests
 
 We use TypeScript for type check, `eslint` with `prettier` for
-linting/formatting, `jest/detox` for tests (unit and e2e). All tests are run on
-CircleCI for all opened pull requests, but you should use them locally when
+linting/formatting. All tests are run on Github Actions for all opened pull requests, but you should use them locally when
 making changes.
 
-- `yarn test`: Run all tests, except for e2e (see note below).
 - `yarn test:lint`: Run `eslint` check.
 - `yarn test:ts`: Run `tsc` type check.
-- `yarn test:e2e:<ios|android|macos>`: Runs e2e tests. Before you can run it,
-  you should build the app that can be run, by using
-  `yarn build:e2e:<ios|android|macos>`.
+- `yarn test:format`: Run `prettier` check for formatting mistakes.
 
 ## Sending a pull request
 
@@ -65,16 +61,15 @@ Most notably prefixes you'll see:
 
 ## Release process
 
-We use [Semantic Release](http://semantic-release.org) to automatically release
-new versions of the library when changes are merged into `main` branch, which
-we plan to keep stable. Bug fixes take priority in the release order.
+We use [Changeset](https://github.com/changesets/changesets) to manage releases. 
+In your PR, run `yarn changeset` to create a new changeset, describing your changes.
+The Changeset Bot will help you out during opening a PR.
 
 ## Reporting issues
 
 You can report issues on our
-[bug tracker](https://github.com/react-native-community/react-native-async-storage/issues).
-Please search for existing issues and follow the issue template when opening an
-one.
+[bug tracker](https://github.com/react-native-async-storage/async-storage/issues).
+Please search for existing issues and follow the issue template when opening a one.
 
 ## License
 

.github/actions/setup-project/action.yml

@@ -3,13 +3,13 @@ description: Install required tools
 inputs:
   java-version:
     description: Desired Java version
-    default: "17"
+    default: "21.0.8"
   node-version:
     required: false
     description: node version to install
     # Use pre-installed Node version in Ubuntu 22.04 runner
     # https://github.com/actions/runner-images/blob/main/images/ubuntu/Ubuntu2204-Readme.md
-    default: 20.13.1
+    default: 22.18.0
   windows-fix:
     required: false
     description: https://github.com/actions/setup-node/issues/899#issuecomment-1837381044

.github/requirements.in

@@ -0,0 +1,3 @@
+mike==2.1.3
+mkdocs==1.6.1
+mkdocs-material==9.6.20

.github/requirements.txt

@@ -0,0 +1,98 @@
+#
+# This file is autogenerated by pip-compile with Python 3.11
+# by the following command:
+#
+#    pip-compile
+#
+babel==2.17.0
+    # via mkdocs-material
+backrefs==5.9
+    # via mkdocs-material
+certifi==2025.8.3
+    # via requests
+charset-normalizer==3.4.3
+    # via requests
+click==8.2.1
+    # via
+    #   mkdocs
+    #   mkdocs-material
+colorama==0.4.6
+    # via mkdocs-material
+ghp-import==2.1.0
+    # via mkdocs
+idna==3.10
+    # via requests
+importlib-metadata==8.7.0
+    # via mike
+importlib-resources==6.5.2
+    # via mike
+jinja2==3.1.6
+    # via
+    #   mike
+    #   mkdocs
+    #   mkdocs-material
+markdown==3.9
+    # via
+    #   mkdocs
+    #   mkdocs-material
+    #   pymdown-extensions
+markupsafe==3.0.2
+    # via
+    #   jinja2
+    #   mkdocs
+mergedeep==1.3.4
+    # via
+    #   mkdocs
+    #   mkdocs-get-deps
+mike==2.1.3
+    # via -r requirements.in
+mkdocs==1.6.1
+    # via
+    #   -r requirements.in
+    #   mike
+    #   mkdocs-material
+mkdocs-get-deps==0.2.0
+    # via mkdocs
+mkdocs-material==9.6.20
+    # via -r requirements.in
+mkdocs-material-extensions==1.3.1
+    # via mkdocs-material
+packaging==25.0
+    # via mkdocs
+paginate==0.5.7
+    # via mkdocs-material
+pathspec==0.12.1
+    # via mkdocs
+platformdirs==4.4.0
+    # via mkdocs-get-deps
+pygments==2.19.2
+    # via mkdocs-material
+pymdown-extensions==10.16.1
+    # via mkdocs-material
+pyparsing==3.2.5
+    # via mike
+python-dateutil==2.9.0.post0
+    # via ghp-import
+pyyaml==6.0.3
+    # via
+    #   mike
+    #   mkdocs
+    #   mkdocs-get-deps
+    #   pymdown-extensions
+    #   pyyaml-env-tag
+pyyaml-env-tag==1.1
+    # via
+    #   mike
+    #   mkdocs
+requests==2.32.5
+    # via mkdocs-material
+six==1.17.0
+    # via python-dateutil
+urllib3==2.5.0
+    # via requests
+verspec==0.1.0
+    # via mike
+watchdog==6.0.0
+    # via mkdocs
+zipp==3.23.0
+    # via importlib-metadata

.github/scripts/prepare-mkdocs.sh

@@ -0,0 +1,11 @@
+#!/bin/bash
+
+# The website is built using MkDocs with the Material theme.
+# https://squidfunk.github.io/mkdocs-material/
+# It requires Python to run.
+# Install the packages with the following command:
+# pip install --no-deps -r requirements.txt
+
+
+cp packages/async-storage/CHANGELOG.md docs/changelog.md
+cp .github/CONTRIBUTING.md docs/contributing.md

.github/workflows/deploy-docs.yml

@@ -0,0 +1,44 @@
+name: Deploy docs
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - "docs/**"
+      - "mkdocs.yml"
+      - "packages/async-storage/CHANGELOG.md"
+  workflow_dispatch:
+jobs:
+  deploy-docs:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v5
+        with:
+          token: ${{ secrets.GH_BOT_TOKEN }}
+      - uses: actions/setup-python@v6
+        with:
+          python-version: 3.11
+      - name: Read docs version
+        id: version
+        run: |
+          VERSION_DOCS=$(node -p "require('./package.json').versionDocs || ''")
+          echo "versionDocs=$VERSION_DOCS" >> $GITHUB_OUTPUT
+      - name: Prepare MkDocs
+        run: |
+          pip install --no-deps -r .github/requirements.txt
+          .github/scripts/prepare-mkdocs.sh
+      # required for mike
+      - name: Setup git user
+        run: ./setup-ci-git-user.sh
+        working-directory: .github/scripts
+        env:
+          GITHUB_TOKEN: ${{ secrets.GH_RELEASE_TOKEN }}
+          GITHUB_NAME: ${{ vars.GH_BOT_NAME }}
+          GITHUB_EMAIL: ${{ vars.GH_BOT_EMAIL }}
+          GIT_SET_GLOBAL_USER: true
+      # required for mike
+      - name: Setup gh-pages remote
+        run: |
+          git remote add docs https://github.com/react-native-async-storage/react-native-async-storage.github.io.git
+      - name: Deploy Docs with mike
+        run: mike deploy -u -r docs --push ${{ steps.version.outputs.versionDocs }} latest