Merge pull request #84 from objectstack-ai/copilot/add-auto-merge-configuration

Author: hotlong

.github/WORKFLOWS.md

@@ -338,6 +338,67 @@ Add these badges to show workflow status:
 3. Update documentation
 4. Monitor first few runs after changes
 
+## Automatic Lockfile Merge Resolution
+
+### Overview
+
+The repository is configured to automatically resolve merge conflicts in `pnpm-lock.yaml` using a custom Git merge driver. This prevents manual intervention when lockfile conflicts occur during branch merges or automated workflows.
+
+### How It Works
+
+**Repository Configuration** (`.gitattributes`):
+```
+pnpm-lock.yaml merge=pnpm-merge
+```
+
+This tells Git to use the `pnpm-merge` driver when merging `pnpm-lock.yaml` files.
+
+**Workflow Configuration** (Applied in CI workflows):
+```yaml
+- name: Configure Git merge driver for pnpm-lock.yaml
+  run: |
+    # Configure custom merge driver for pnpm-lock.yaml
+    # This allows Git to automatically resolve lockfile conflicts by regenerating it
+    git config merge.pnpm-merge.name "pnpm-lock.yaml merge driver"
+    git config merge.pnpm-merge.driver "pnpm install --no-frozen-lockfile"
+```
+
+### When It's Used
+
+This configuration is active in the following workflows:
+- **Changeset Release** (`changeset-release.yml`): Handles lockfile updates during version bumping
+- **Auto Changelog** (`changelog.yml`): Prevents conflicts during automated changelog updates
+
+### Adding to New Workflows
+
+If you create a workflow that performs git merge operations or might encounter lockfile conflicts, add the configuration step **after checkout** and **before any merge operation**:
+
+```yaml
+steps:
+  - name: Checkout code
+    uses: actions/checkout@v4
+    with:
+      fetch-depth: 0
+
+  - name: Configure Git merge driver for pnpm-lock.yaml
+    run: |
+      git config merge.pnpm-merge.name "pnpm-lock.yaml merge driver"
+      git config merge.pnpm-merge.driver "pnpm install --no-frozen-lockfile"
+
+  # ... rest of your workflow steps including merge operations
+```
+
+### Benefits
+
+- **Fully Automated**: No manual intervention needed for lockfile conflicts
+- **Clean Repository**: Configuration is temporary (CI-only), doesn't modify repository files
+- **Reliable**: Uses pnpm's built-in dependency resolution to regenerate lockfiles
+- **Consistent**: Ensures lockfiles are always in sync with package.json changes
+
+### Local Development
+
+For local development, contributors can configure the same merge driver by following the instructions in [CONTRIBUTING.md](../CONTRIBUTING.md).
+
 ## Future Enhancements
 
 Potential workflow additions:

.github/workflows/changelog.yml

@@ -18,6 +18,13 @@ jobs:
         with:
           fetch-depth: 0
 
+      - name: Configure Git merge driver for pnpm-lock.yaml
+        run: |
+          # Configure custom merge driver for pnpm-lock.yaml
+          # This allows Git to automatically resolve lockfile conflicts by regenerating it
+          git config merge.pnpm-merge.name "pnpm-lock.yaml merge driver"
+          git config merge.pnpm-merge.driver "pnpm install --no-frozen-lockfile"
+
       - name: Generate changelog
         uses: orhun/git-cliff-action@v4
         id: changelog

.github/workflows/changeset-check.yml

@@ -25,7 +25,7 @@ jobs:
       - name: Setup pnpm
         uses: pnpm/action-setup@v4
         with:
-          version: 9
+          version: 10
 
       - name: Setup Node.js
         uses: actions/setup-node@v4

.github/workflows/changeset-release.yml

@@ -25,7 +25,7 @@ jobs:
       - name: Setup pnpm
         uses: pnpm/action-setup@v4
         with:
-          version: 9
+          version: 10
 
       - name: Setup Node.js
         uses: actions/setup-node@v4
@@ -34,6 +34,13 @@ jobs:
           cache: 'pnpm'
           registry-url: 'https://registry.npmjs.org'
 
+      - name: Configure Git merge driver for pnpm-lock.yaml
+        run: |
+          # Configure custom merge driver for pnpm-lock.yaml
+          # This allows Git to automatically resolve lockfile conflicts by regenerating it
+          git config merge.pnpm-merge.name "pnpm-lock.yaml merge driver"
+          git config merge.pnpm-merge.driver "pnpm install --no-frozen-lockfile"
+
       - name: Install dependencies
         run: pnpm install --frozen-lockfile
 

.github/workflows/dependabot-auto-merge.yml

@@ -13,6 +13,27 @@ jobs:
     runs-on: ubuntu-latest
     if: ${{ github.actor == 'dependabot[bot]' }}
     steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Setup pnpm
+        uses: pnpm/action-setup@v4
+        with:
+          version: 10
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '20.x'
+          cache: 'pnpm'
+
+      - name: Configure Git merge driver for pnpm-lock.yaml
+        run: |
+          # Configure custom merge driver for pnpm-lock.yaml
+          # This allows Git to automatically resolve lockfile conflicts by regenerating it
+          git config merge.pnpm-merge.name "pnpm-lock.yaml merge driver"
+          git config merge.pnpm-merge.driver "pnpm install --no-frozen-lockfile"
+
       - name: Dependabot metadata
         id: metadata
         uses: dependabot/fetch-metadata@v2