Enable dual-branch release workflows for independent 1.x and 2.x version management (#21)

* Initial plan

* Implement dual-branch release workflow setup

Co-authored-by: zth <[email protected]>

* Add README documentation and test changeset functionality

Co-authored-by: zth <[email protected]>

* Final verification and testing complete

Co-authored-by: zth <[email protected]>

---------

Co-authored-by: copilot-swe-agent[bot] <[email protected]>
Co-authored-by: zth <[email protected]>

Author: Copilot

.github/workflows/release-2x.yml

@@ -0,0 +1,49 @@
+# Release workflow for the 2.x branch (2.x versions)
+# This workflow handles releases for the 2.x version line of rescript-bun.
+# It only triggers on pushes to the 2.x branch to ensure 2.x releases are properly managed.
+name: Release (2.x)
+
+permissions:
+  contents: write
+  pull-requests: write
+
+on:
+  push:
+    branches:
+      - 2.x
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Use Node.js 20.x
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          registry-url: https://registry.npmjs.org/
+
+      - name: Setup Bun
+        uses: oven-sh/setup-bun@v1
+        with:
+          bun-version: latest
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Build project
+        run: bun run build
+
+      # This workflow is specifically for 2.x releases on the 2.x branch
+      # The changeset action will handle version bumps according to changeset config
+      - name: Create Release Pull Request or Publish to npm (2.x releases)
+        uses: changesets/action@v1
+        with:
+          publish: bun run release
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}

.github/workflows/release.yml .github/workflows/release-main.yml.github/workflows/release.yml renamed to .github/workflows/release-main.yml

@@ -1,4 +1,7 @@
-name: Release
+# Release workflow for the main branch (1.x versions)
+# This workflow handles releases for the 1.x version line of rescript-bun.
+# It only triggers on pushes to the main branch to ensure 1.x releases are properly managed.
+name: Release (1.x)
 
 permissions:
   contents: write
@@ -35,10 +38,12 @@ jobs:
       - name: Build project
         run: bun run build
 
-      - name: Create Release Pull Request or Publish to npm
+      # This workflow is specifically for 1.x releases on the main branch
+      # The changeset action will handle version bumps according to changeset config
+      - name: Create Release Pull Request or Publish to npm (1.x releases)
         uses: changesets/action@v1
         with:
           publish: bun run release
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}

.github/workflows/test.yml

@@ -1,10 +1,13 @@
+# Test workflow for both main (1.x) and 2.x branches
+# This workflow runs tests on both the main branch (1.x development) 
+# and the 2.x branch (2.x development) to ensure code quality across both version lines.
 name: Test
 
 on:
   push:
-    branches: [main]
+    branches: [main, 2.x]
   pull_request:
-    branches: [main]
+    branches: [main, 2.x]
 
 jobs:
   build:

DUAL_BRANCH_SETUP.md

@@ -0,0 +1,50 @@
+# Dual-Branch Release Setup
+
+This repository uses a dual-branch approach for managing releases:
+
+## Branch Structure
+
+- **`main` branch**: Handles 1.x version releases
+- **`2.x` branch**: Handles 2.x version releases
+
+## Workflow Files
+
+### Release Workflows
+
+- **`release-main.yml`**: Triggers on pushes to `main` branch, handles 1.x releases
+- **`release-2x.yml`**: Triggers on pushes to `2.x` branch, handles 2.x releases
+
+Both workflow files exist on both branches, but each only triggers on its respective branch to prevent interference.
+
+### Test Workflow
+
+- **`test.yml`**: Runs on both `main` and `2.x` branches to ensure code quality across both version lines
+
+## Changeset Configuration
+
+Each branch has its own changeset configuration:
+
+- **`main` branch**: `baseBranch: "main"` in `.changeset/config.json`
+- **`2.x` branch**: `baseBranch: "2.x"` in `.changeset/config.json`
+
+This ensures that changesets work correctly on each branch by comparing against the appropriate base.
+
+## Release Process
+
+### For 1.x releases (main branch):
+1. Create changeset: `npm run changeset`
+2. Commit and push to main branch
+3. The `release-main.yml` workflow will create a release PR or publish
+
+### For 2.x releases (2.x branch):
+1. Switch to 2.x branch: `git checkout 2.x`
+2. Create changeset: `npm run changeset`
+3. Commit and push to 2.x branch
+4. The `release-2x.yml` workflow will create a release PR or publish
+
+## Important Notes
+
+- Both branches maintain independent changeset histories
+- Workflows do not interfere with each other due to branch-specific triggers
+- Each branch can have different dependencies and configurations as needed
+- The version numbers are managed separately per branch (1.x vs 2.x)

README.md

@@ -2,6 +2,14 @@
 
 _Check out the `2.x` branch for ReScript v12 support._
 
+## Release Branches
+
+This repository maintains two active release branches:
+- **`main` branch**: For 1.x releases (ReScript v11+ support)
+- **`2.x` branch**: For 2.x releases (ReScript v12+ support)
+
+Each branch has independent release cycles managed by changesets. See [DUAL_BRANCH_SETUP.md](DUAL_BRANCH_SETUP.md) for detailed information about the dual-branch setup.
+
 Use [Bun](https://bun.sh) with ReScript.
 
 > **Currently alpha state software**. You're encouraged to start using it, but please report all issues. There will be both bindings missing and some bindings will probably be wrong/suboptimal. We're going to work through the API surface as we go. Report all issues you find!