Commit `d2178a52d29e`

Vincent Demeester <vincent@sbr.pm>

2026-01-14 09:30:12

docs(nixpkgs): add merge-bot documentation

Add comprehensive documentation for @NixOS/nixpkgs-merge-bot usage: - Command: @NixOS/nixpkgs-merge-bot merge - Requirements (maintainer status, pkgs/by-name/, etc.) - Added to Review workflow as Step 5 - Added to review checklist - Added to main SKILL.md Enables maintainers to trigger automated merges for eligible PRs they maintain (version bumps, dependency updates, etc.) Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>

main

1 parent 08762fe

Changed files (3)

dots

.config

claude

skills

Nixpkgs

workflows

Review.md

review-checklist.md

SKILL.md

@@ -138,6 +138,47 @@ exit
 nixpkgs-review pr 12345 --post-result
 ```
 
+### Step 5: Merge (Maintainers Only)
+
+For PRs labeled `2.status: merge-bot eligible`, maintainers can request automated merge:
+
+```bash
+# Post comment on PR to trigger auto-merge
+gh pr comment 12345 --body "@NixOS/nixpkgs-merge-bot merge"
+
+# Or via web interface: comment "@NixOS/nixpkgs-merge-bot merge"
+```
+
+**Requirements:**
+- ✅ You are listed as maintainer of ALL touched packages
+- ✅ PR targets a development branch (master, staging, etc.)
+- ✅ PR touches only files in `pkgs/by-name/`
+- ✅ PR is approved OR opened by r-ryantm/committer
+- ✅ You are a member of @NixOS/nixpkgs-maintainers
+
+**Use cases:**
+- Simple version bumps for packages you maintain
+- Dependency updates for your packages
+- Low-risk changes to packages you maintain
+
+**Note:** Sometimes GitHub gets stuck after enabling Auto Merge. Leave another approval to trigger the merge.
+
+**Example workflow:**
+```bash
+# 1. Review PR
+nixpkgs-review pr 12345
+
+# 2. Test package
+package-name --version
+
+# 3. Approve (in nix-shell)
+nixpkgs-review approve
+exit
+
+# 4. Trigger merge (if you're maintainer and PR is eligible)
+gh pr comment 12345 --body "@NixOS/nixpkgs-merge-bot merge"
+```
+
 ## What to Check
 
 ### 1. Package Builds Successfully

@@ -17,6 +17,17 @@
    - Test `--help` output
    - Run basic functionality tests
 
+4. **Merge Bot (for Maintainers)**
+   - If PR has label `2.status: merge-bot eligible`, you can request automated merge
+   - Command: `@NixOS/nixpkgs-merge-bot merge` (in PR comment)
+   - **Requirements**:
+     - You are listed as maintainer of all touched packages
+     - PR targets a development branch (master, staging, etc.)
+     - PR touches only files in `pkgs/by-name/`
+     - PR is approved OR opened by r-ryantm/committer
+   - Useful for simple version bumps and dependency updates
+   - Note: Sometimes GitHub gets stuck - leave another approval to trigger merge
+
 ---
 
 ## Code Quality Checks

@@ -166,6 +166,31 @@ nix-shell> nixpkgs-review comments
 nix-shell> exit
 ```
 
+### Merge Bot (Maintainers Only)
+
+For PRs labeled `2.status: merge-bot eligible`, maintainers can request automated merge:
+
+```bash
+# Post comment on PR to trigger auto-merge
+gh pr comment 12345 --body "@NixOS/nixpkgs-merge-bot merge"
+
+# Or via web interface: comment "@NixOS/nixpkgs-merge-bot merge"
+```
+
+**Requirements:**
+- You are listed as maintainer of ALL touched packages
+- PR targets a development branch (master, staging, etc.)
+- PR touches only files in `pkgs/by-name/`
+- PR is approved OR opened by r-ryantm/committer
+- You are a member of @NixOS/nixpkgs-maintainers
+
+**Use cases:**
+- Simple version bumps you maintain
+- Dependency updates for your packages
+- Low-risk changes to packages you maintain
+
+**Note:** Sometimes GitHub gets stuck after enabling Auto Merge. Leave another approval to trigger the merge.
+
 ### Review Local Changes
 ```bash
 # Review your uncommitted changes

Commit d2178a52d29e

Commit `d2178a52d29e`