docs: publish notifee docs via docs.page

.gitattributes

@@ -1,4 +1,4 @@
 *.xcodeproj binary
 *.xcworkspace binary
-docs-react-native/typedoc.json merge=theirs linguist-vendored
-docs-react-native/typedoc.min.json merge=theirs linguist-vendored
+docs/typedoc.json merge=theirs linguist-vendored
+docs/typedoc.min.json merge=theirs linguist-vendored

.github/workflows/linting.yml

@@ -23,7 +23,7 @@ jobs:
           submodules: recursive
       - uses: actions/setup-node@v4
         with:
-          node-version: 18
+          node-version: 20
       - name: Configure JDK
         uses: actions/setup-java@v4
         with:
@@ -64,7 +64,7 @@ jobs:
           submodules: recursive
       - uses: actions/setup-node@v4
         with:
-          node-version: 18
+          node-version: 20
       - name: Set workflow variables
         id: workflow-variables
         run: |
@@ -98,7 +98,7 @@ jobs:
           submodules: recursive
       - uses: actions/setup-node@v4
         with:
-          node-version: 18
+          node-version: 20
       - name: Set workflow variables
         id: workflow-variables
         run: |

.github/workflows/tests_e2e_android.yml

@@ -4,13 +4,13 @@ on:
   workflow_dispatch:
   pull_request:
     paths-ignore:
-      - 'docs-react-native/**'
+      - 'docs/**'
       - '**/*.md'
   push:
     branches:
       - main
     paths-ignore:
-      - 'docs-react-native/**'
+      - 'docs/**'
       - '**/*.md'
 
 concurrency:
@@ -58,7 +58,7 @@ jobs:
 
       - uses: actions/setup-node@v4
         with:
-          node-version: 18
+          node-version: 20
 
       - name: Set workflow variables
         id: workflow-variables

.github/workflows/tests_e2e_ios.yml

@@ -4,13 +4,13 @@ on:
   workflow_dispatch:
   pull_request:
     paths-ignore:
-      - 'docs-react-native/**'
+      - 'docs/**'
       - '**/*.md'
   push:
     branches:
       - main
     paths-ignore:
-      - 'docs-react-native/**'
+      - 'docs/**'
       - '**/*.md'
 
 concurrency:
@@ -32,7 +32,7 @@ jobs:
 
       - uses: actions/setup-node@v4
         with:
-          node-version: 18
+          node-version: 20
 
       - uses: maxim-lobanov/setup-xcode@v1
         with:

.github/workflows/tests_jest.yml

@@ -4,13 +4,13 @@ on:
   workflow_dispatch:
   pull_request:
     paths-ignore:
-      - 'docs-react-native/**'
+      - 'docs/**'
       - '**/*.md'
   push:
     branches:
       - main
     paths-ignore:
-      - 'docs-react-native/**'
+      - 'docs/**'
       - '**/*.md'
 
 concurrency:
@@ -31,7 +31,7 @@ jobs:
           submodules: recursive
       - uses: actions/setup-node@v4
         with:
-          node-version: 18
+          node-version: 20
       - name: Set workflow variables
         id: workflow-variables
         run: |

.github/workflows/tests_junit.yml

@@ -5,12 +5,13 @@ on:
   pull_request:
     paths:
       - '.github/workflows/*.yml'
+      - 'docs/**'
       - 'android/**'
   push:
     branches:
       - main
     paths-ignore:
-      - 'docs-react-native/**'
+      - 'docs/**'
       - '**/*.md'
 
 concurrency:

.releaserc

@@ -17,8 +17,8 @@
     [
       "@semantic-release/changelog",
       {
-        "changelogFile": "docs-react-native/react-native/docs/release-notes.md",
-        "changelogTitle": "---\ntitle: Releases\ndescription: Notifee API releases\nnext: /react-native/docs/usage\nprevious: /react-native/docs/installation\n---"
+        "changelogFile": "docs/react-native/release-notes.mdx",
+        "changelogTitle": "---\ntitle: Releases\ndescription: Notifee API releases\n---"
       }
     ],
     [
@@ -33,7 +33,7 @@
       "@semantic-release/git",
       {
         "assets": [
-          "docs-react-native/react-native/docs/release-notes.md",
+          "docs/react-native/release-notes.mdx",
           "packages/react-native/package.json"
         ],
         "message": "chore(release): ${nextRelease.version} [skip ci] \n\n${nextRelease.notes}"

CONTRIBUTING.md

@@ -82,15 +82,36 @@ Maintainers with write access to the repo and the npm organization can publish n
 
 ### Release Checklist
 
+#### Automated Process
+
+**Note: release is fully automated now in `.github/workflows/publish.yml` and controlled by the `.releaserc` file**
+
+Simply navigate to the release publish workflow, and use the manual trigger to publish from main branch:
+
+1. https://github.com/invertase/notifee/actions/workflows/publish.yml
+
+Afterwards, you may verify that everything worked by checking the expected work products:
+
+1. Verify that there is a new github release: https://github.com/invertase/notifee/releases
+1. Verify that there is a new npmjs release (may take a moment to update): https://www.npmjs.com/package/@notifee/react-native?activeTab=versions
+1. Verify that the changelog is updated: https://docs.page/invertase/notifee/react-native/release-notes
+1. Verify that there is a new tag correctly created: https://github.com/invertase/notifee/tags
+1. Verify that there is a commit with that tag, with the updated release notes: https://github.com/invertase/notifee/commits/main/
+
+#### Manual Process
+
+If for some reason the automated process is not working, or you want to re-automate it using some other tools, these are the steps to take to correctly create and publish a release:
+
 1. Navigate to the React Native package: `cd packages/react-native`
-1. Update release notes [here](https://github.com/invertase/notifee/blob/main/docs-react-native/react-native/docs/release-notes.md)
+1. Update release notes [here](https://github.com/invertase/notifee/blob/main/docs/react-native/release-notes.mdx)
 1. Bump version: `npm version {major/minor/patch} --legacy-peer-deps`
-1. Publish to npm: `npm publish` (this generates a new core AAR)
+1. Publish to npm: `npm publish` (this generates a new core AAR, and requires a valid NPM login with permission to publish the Notifee package on npmjs.com)
 1. Commit those changes (after npm publish so new AAR files are committed)
 1. Tag the repo (current format is `@notifee/react-native@x.y.z`)
 1. Push the release notes / version / tag to the repo: `git push --tags`
 1. Create a release on the repo:
-    ```
+
+    ```bash
     export TAGNAME=`git tag --list|sort -r|head -1`
-    gh release create ${TAGNAME} --title "${TAGNAME}" --notes "[Release Notes](https://github.com/invertase/notifee/blob/main/docs-react-native/react-native/docs/release-notes.md)"
+    gh release create ${TAGNAME} --title "${TAGNAME}" --notes "[Release Notes](https://github.com/invertase/notifee/blob/main/docs/react-native/release-notes.mdx)"
     ```