Merge pull request #605 from xmtp/rygine/beta-release-docs

Add docs for creating beta releases

.github/workflows/js-sdk.yml

@@ -9,10 +9,14 @@ on:
     paths:
       - 'packages/js-sdk/**'
       - '.github/workflows/js-sdk.yml'
+      - 'dev/**'
       - '.node-version'
       - '.nvmrc'
       - '.prettierignore'
       - '.prettierrc.cjs'
+      - '.yarnrc.yml'
+      - 'turbo.json'
+      - 'yarn.lock'
 
 jobs:
   typecheck:

.github/workflows/mls-client.yml

@@ -9,10 +9,14 @@ on:
     paths:
       - 'packages/mls-client/**'
       - '.github/workflows/mls-client.yml'
+      - 'dev/**'
       - '.node-version'
       - '.nvmrc'
       - '.prettierignore'
       - '.prettierrc.cjs'
+      - '.yarnrc.yml'
+      - 'turbo.json'
+      - 'yarn.lock'
 
 jobs:
   typecheck:

.github/workflows/noop.yml

@@ -0,0 +1,66 @@
+name: No code changes
+
+on:
+  push:
+    branches:
+      - main
+
+  pull_request:
+    paths:
+      - '.changeset/**'
+      - '.github/**'
+      - '!.github/workflows/js-sdk.yml'
+      - '!.github/workflows/mls-client.yml'
+      - '.vscode/**'
+      - '.yarn/**'
+      - '*'
+      - '!.node-version'
+      - '!.nvmrc'
+      - '!.prettierignore'
+      - '!.prettierrc.cjs'
+      - '!.yarnrc.yml'
+      - '!turbo.json'
+      - '!yarn.lock'
+
+jobs:
+  typecheck:
+    name: Typecheck
+    runs-on: ubuntu-latest
+    steps:
+      - run: echo "Nothing to typecheck"
+
+  lint:
+    name: Lint
+    runs-on: ubuntu-latest
+    steps:
+      - run: echo "Nothing to lint"
+
+  prettier:
+    name: Prettier
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version-file: '.nvmrc'
+          cache: 'yarn'
+        env:
+          SKIP_YARN_COREPACK_CHECK: '1'
+      - name: Enable corepack
+        run: corepack enable
+      - name: Install dependencies
+        run: yarn
+      - name: Format check
+        run: yarn prettier -c .
+
+  test:
+    name: Test
+    runs-on: ubuntu-latest
+    steps:
+      - run: echo "Nothing to test"
+
+  build:
+    name: Build
+    runs-on: ubuntu-latest
+    steps:
+      - run: echo "Nothing to build"

CONTRIBUTING.md

@@ -53,3 +53,9 @@ Manual validation requires setting up a client app such as the [example app](htt
 ## 🚢 Publishing
 
 This repository uses [changesets](https://github.com/changesets/changesets) to publish updates. Pull requests must contain a changeset in order for changes to be published. The [changeset-bot](https://github.com/apps/changeset-bot) will guide you through this process.
+
+### Beta releases
+
+To begin development on a beta release, make sure the `beta` branch is up to date with the `main` branch. Create a new branch from the `beta` branch. After merging your changes into the `beta` branch, you must create a PR from the `beta` branch into the `releases/beta` branch. Once merged, a beta release will be published to the NPM registry.
+
+After the beta period has ended, merge the latest `beta` branch into `main` to publish a production release with the changes.