Add skip_draft_prs configuration option (#18)

zmdavis · web-flow · web-flow · commit d9fcbcbe47a8 · 2025-08-27T11:17:51.000-07:00
* Add skip_draft_prs configuration option

- Add new skip_draft_prs input parameter to action.yml
- Implement draft PR checking in shouldSkip() method
- Add comprehensive tests for draft PR functionality
- Update documentation in README.md and CONFIGURATION.md
- Update advanced usage example to demonstrate the feature

This feature allows users to configure Felix to skip processing
draft PRs entirely by setting skip_draft_prs: true, providing
more control over when automatic fixes are applied.

* Add test workflow for draft PR skip functionality

* 🤖 Fix-it Felix: Auto-fix formatting issues

* Remove test workflow - dogfooding test completed successfully

---------

Co-authored-by: zmdavis &lt;zmdavis@users.noreply.github.com&gt;
Co-authored-by: Fix-it Felix[bot] &lt;noreply@github.com&gt;
diff --git a/README.md b/README.md
@@ -13,6 +13,7 @@
 - 🛡️ **Safety First**: Built-in safeguards against infinite loops
 - 🔍 **Dry-run Mode**: Preview changes without committing
 - 🚫 **Skip Control**: Label-based opt-out mechanism
+- 📄 **Draft PR Control**: Optionally skip draft PRs
 - 🍴 **Fork Friendly**: Handles forked PRs gracefully
 
 ## 🚀 Quick Start
@@ -70,6 +71,7 @@ jobs:
 | `config_path`    | Path to Felix configuration file                           | No       | `.felixrc.json`                                   |
 | `dry_run`        | Run in dry-run mode (comment instead of commit)            | No       | `false`                                           |
 | `skip_label`     | PR label that skips Felix processing                       | No       | `skip-felix`                                      |
+| `skip_draft_prs` | Skip processing draft pull requests                        | No       | `false`                                           |
 | `allowed_bots`   | Comma-separated list of bot names Felix should run against | No       | ``                                                |
 | `paths`          | Comma-separated list of paths to run fixers on             | No       | `.`                                               |
 
@@ -176,9 +178,27 @@ Use your own npm scripts instead of built-in commands:
 - Skips processing (cannot commit to forks with default token)
 - Logs appropriate messages
 
+### Draft PR Handling
+
+By default, Felix processes draft PRs just like regular PRs. You can configure Felix to skip draft PRs entirely:
+
+```yaml
+- name: Run Fix-it Felix
+  uses: launchdarkly/fix-it-felix-action@v1
+  with:
+    skip_draft_prs: true
+```
+
+This is useful when you want to:
+
+- Prevent commits on work-in-progress PRs
+- Let developers refine their changes before auto-fixing
+- Reduce action runs during development
+
 ### Skip Mechanisms
 
 - **Label-based**: Add `skip-felix` label to PR
+- **Draft PRs**: Set `skip_draft_prs: true` to skip draft PRs
 - **Configuration**: Set `fixers: []` in `.felixrc.json`
 - **Event-based**: Only runs on specific PR events
 
diff --git a/action.yml b/action.yml
@@ -49,6 +49,11 @@ inputs:
     required: false
     default: 'false'
 
+  skip_draft_prs:
+    description: 'Skip processing draft pull requests'
+    required: false
+    default: 'false'
+
 outputs:
   fixes_applied:
     description: 'Whether any fixes were applied'
diff --git a/dist/index.js b/dist/index.js
@@ -30182,8 +30182,13 @@ class FixitFelix {
             core.info('Not a pull request event');
             return true;
         }
-        // Skip if PR has skip label
         const pr = this.context.payload.pull_request;
+        // Skip if draft PR and skipDraftPrs is enabled
+        if (this.inputs.skipDraftPrs && pr?.draft) {
+            core.info('PR is a draft and skip_draft_prs is enabled');
+            return true;
+        }
+        // Skip if PR has skip label
         if (pr?.labels?.some((label) => label.name === this.inputs.skipLabel)) {
             core.info(`PR has skip label: ${this.inputs.skipLabel}`);
             return true;
@@ -31426,7 +31431,8 @@ async function run() {
             allowedBots: core.getInput('allowed_bots'),
             paths: core.getInput('paths'),
             personalAccessToken: core.getInput('personal_access_token'),
-            debug: core.getBooleanInput('debug')
+            debug: core.getBooleanInput('debug'),
+            skipDraftPrs: core.getBooleanInput('skip_draft_prs')
         };
         const felix = new felix_1.FixitFelix(inputs, github.context);
         const result = await felix.run();
diff --git a/dist/index.js.map b/dist/index.js.map
diff --git a/docs/CONFIGURATION.md b/docs/CONFIGURATION.md
@@ -40,6 +40,7 @@ Configure Felix behavior through GitHub Action inputs:
 | `config_path`    | Path to Felix configuration file                          | `.felixrc.json`                                   |
 | `dry_run`        | Run in dry-run mode (comment instead of commit)           | `false`                                           |
 | `skip_label`     | PR label that skips Felix processing                      | `skip-felix`                                      |
+| `skip_draft_prs` | Skip processing draft pull requests                       | `false`                                           |
 | `allowed_bots`   | Comma-separated list of bot names Felix should run against | (empty)                                           |
 
 ### Example
@@ -68,6 +69,7 @@ steps:
       config_path: '.custom-felix.json'
       dry_run: false
       skip_label: 'no-autofix'
+      skip_draft_prs: true
       allowed_bots: 'dependabot,renovate'
 ```
 
diff --git a/examples/advanced-usage.yml b/examples/advanced-usage.yml
@@ -34,6 +34,7 @@ jobs:
           commit_message: '🤖 Fix-it Felix: Automated code quality improvements'
           config_path: '.felixrc.json'
           skip_label: 'no-autofix'
+          skip_draft_prs: true
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
diff --git a/src/felix.ts b/src/felix.ts
@@ -135,8 +135,15 @@ export class FixitFelix {
       return true
     }
 
-    // Skip if PR has skip label
     const pr = this.context.payload.pull_request
+
+    // Skip if draft PR and skipDraftPrs is enabled
+    if (this.inputs.skipDraftPrs && pr?.draft) {
+      core.info('PR is a draft and skip_draft_prs is enabled')
+      return true
+    }
+
+    // Skip if PR has skip label
     if (pr?.labels?.some((label: any) => label.name === this.inputs.skipLabel)) {
       core.info(`PR has skip label: ${this.inputs.skipLabel}`)
       return true
diff --git a/src/index.ts b/src/index.ts
@@ -13,7 +13,8 @@ async function run(): Promise<void> {
       allowedBots: core.getInput('allowed_bots'),
       paths: core.getInput('paths'),
       personalAccessToken: core.getInput('personal_access_token'),
-      debug: core.getBooleanInput('debug')
+      debug: core.getBooleanInput('debug'),
+      skipDraftPrs: core.getBooleanInput('skip_draft_prs')
     }
 
     const felix = new FixitFelix(inputs, github.context)
diff --git a/src/types.ts b/src/types.ts
@@ -8,6 +8,7 @@ export interface FelixInputs {
   paths: string
   personalAccessToken?: string
   debug: boolean
+  skipDraftPrs: boolean
 }
 
 export interface FelixConfig {
diff --git a/tests/config.test.ts b/tests/config.test.ts
@@ -16,7 +16,8 @@ describe('ConfigManager', () => {
     allowedBots: '',
     paths: '',
     personalAccessToken: '',
-    debug: false
+    debug: false,
+    skipDraftPrs: false
   }
 
   beforeEach(() => {
diff --git a/tests/felix.test.ts b/tests/felix.test.ts
@@ -29,7 +29,8 @@ describe('FixitFelix', () => {
     allowedBots: '',
     paths: '',
     personalAccessToken: '',
-    debug: false
+    debug: false,
+    skipDraftPrs: false
   }
 
   const mockContext = {
@@ -591,4 +592,228 @@ describe('FixitFelix', () => {
       process.env.GITHUB_TOKEN = originalEnv
     })
   })
+
+  describe('draft PR handling', () => {
+    it('should skip when PR is draft and skip_draft_prs is enabled', async () => {
+      const inputsWithSkipDraft = {
+        ...defaultInputs,
+        skipDraftPrs: true
+      }
+
+      const draftContext = {
+        ...mockContext,
+        payload: {
+          ...mockContext.payload,
+          pull_request: {
+            ...mockContext.payload.pull_request,
+            draft: true
+          }
+        }
+      }
+
+      const felix = new FixitFelix(inputsWithSkipDraft, draftContext)
+      const result = await felix.run()
+
+      expect(result.fixesApplied).toBe(false)
+      expect(result.changedFiles).toEqual([])
+    })
+
+    it('should proceed when PR is draft but skip_draft_prs is disabled', async () => {
+      const inputsWithoutSkipDraft = {
+        ...defaultInputs,
+        skipDraftPrs: false
+      }
+
+      // Create a proper mock context with PR details
+      const draftPRContext = {
+        repo: { owner: 'test-owner', repo: 'test-repo' },
+        issue: { number: 456 },
+        eventName: 'pull_request',
+        payload: {
+          pull_request: {
+            number: 456,
+            draft: true,
+            base: {
+              ref: 'main',
+              repo: {
+                owner: { login: 'test-owner' },
+                name: 'test-repo',
+                full_name: 'test-owner/test-repo'
+              }
+            },
+            head: {
+              ref: 'feature',
+              repo: { full_name: 'test-owner/test-repo' }
+            }
+          }
+        }
+      } as any
+
+      // Mock core.getInput to provide a token
+      jest.spyOn(require('@actions/core'), 'getInput').mockImplementation((name: any) => {
+        if (name === 'personal_access_token') return 'mock-token'
+        return ''
+      })
+
+      // Mock process.env.GITHUB_TOKEN as fallback
+      const originalEnv = process.env.GITHUB_TOKEN
+      process.env.GITHUB_TOKEN = 'mock-github-token'
+
+      // Mock GitHub API
+      const mockOctokit = {
+        paginate: jest.fn().mockResolvedValue([{ filename: 'src/test.js' }]),
+        rest: {
+          pulls: {
+            listFiles: jest.fn()
+          }
+        }
+      }
+
+      jest.spyOn(require('@actions/github'), 'getOctokit').mockReturnValue(mockOctokit)
+
+      // Mock fs.existsSync to return true for test files
+      const mockFs = require('fs')
+      mockFs.existsSync.mockImplementation((path: string) => {
+        return path === 'src/test.js'
+      })
+
+      // Mock git commands for regular processing
+      mockExec.exec.mockImplementation((command, args, options) => {
+        if (args && args.includes('--pretty=format:%an')) {
+          options?.listeners?.stdout?.(Buffer.from('Regular User'))
+        } else if (args && args.includes('--pretty=format:%s')) {
+          options?.listeners?.stdout?.(Buffer.from('Regular commit'))
+        } else if (command === 'npx' && args && args.includes('--version')) {
+          // Mock prettier version check
+          options?.listeners?.stdout?.(Buffer.from('2.8.0'))
+          return Promise.resolve(0)
+        } else if (
+          command === 'npx' &&
+          args &&
+          args.includes('prettier') &&
+          args.includes('--write')
+        ) {
+          // Mock prettier command
+          return Promise.resolve(0)
+        } else if (args && args.includes('--name-only') && !args.includes('origin/')) {
+          // Mock git diff for changed files after running fixer
+          options?.listeners?.stdout?.(Buffer.from('src/test.js'))
+        }
+        return Promise.resolve(0)
+      })
+
+      const felix = new FixitFelix(inputsWithoutSkipDraft, draftPRContext)
+      const result = await felix.run()
+
+      // Should proceed with fixes even though PR is draft
+      expect(result).toBeDefined()
+      expect(mockExec.exec).toHaveBeenCalledWith(
+        'npx',
+        expect.arrayContaining(['prettier', '--write']),
+        expect.any(Object)
+      )
+
+      // Restore environment
+      process.env.GITHUB_TOKEN = originalEnv
+    })
+
+    it('should proceed when PR is not draft regardless of skip_draft_prs setting', async () => {
+      const inputsWithSkipDraft = {
+        ...defaultInputs,
+        skipDraftPrs: true
+      }
+
+      // Create a proper mock context with PR details for non-draft PR
+      const nonDraftPRContext = {
+        repo: { owner: 'test-owner', repo: 'test-repo' },
+        issue: { number: 456 },
+        eventName: 'pull_request',
+        payload: {
+          pull_request: {
+            number: 456,
+            draft: false,
+            base: {
+              ref: 'main',
+              repo: {
+                owner: { login: 'test-owner' },
+                name: 'test-repo',
+                full_name: 'test-owner/test-repo'
+              }
+            },
+            head: {
+              ref: 'feature',
+              repo: { full_name: 'test-owner/test-repo' }
+            }
+          }
+        }
+      } as any
+
+      // Mock core.getInput to provide a token
+      jest.spyOn(require('@actions/core'), 'getInput').mockImplementation((name: any) => {
+        if (name === 'personal_access_token') return 'mock-token'
+        return ''
+      })
+
+      // Mock process.env.GITHUB_TOKEN as fallback
+      const originalEnv = process.env.GITHUB_TOKEN
+      process.env.GITHUB_TOKEN = 'mock-github-token'
+
+      // Mock GitHub API
+      const mockOctokit = {
+        paginate: jest.fn().mockResolvedValue([{ filename: 'src/test.js' }]),
+        rest: {
+          pulls: {
+            listFiles: jest.fn()
+          }
+        }
+      }
+
+      jest.spyOn(require('@actions/github'), 'getOctokit').mockReturnValue(mockOctokit)
+
+      // Mock fs.existsSync to return true for test files
+      const mockFs = require('fs')
+      mockFs.existsSync.mockImplementation((path: string) => {
+        return path === 'src/test.js'
+      })
+
+      // Mock git commands for regular processing
+      mockExec.exec.mockImplementation((command, args, options) => {
+        if (args && args.includes('--pretty=format:%an')) {
+          options?.listeners?.stdout?.(Buffer.from('Regular User'))
+        } else if (args && args.includes('--pretty=format:%s')) {
+          options?.listeners?.stdout?.(Buffer.from('Regular commit'))
+        } else if (command === 'npx' && args && args.includes('--version')) {
+          // Mock prettier version check
+          options?.listeners?.stdout?.(Buffer.from('2.8.0'))
+          return Promise.resolve(0)
+        } else if (
+          command === 'npx' &&
+          args &&
+          args.includes('prettier') &&
+          args.includes('--write')
+        ) {
+          // Mock prettier command
+          return Promise.resolve(0)
+        } else if (args && args.includes('--name-only') && !args.includes('origin/')) {
+          // Mock git diff for changed files after running fixer
+          options?.listeners?.stdout?.(Buffer.from('src/test.js'))
+        }
+        return Promise.resolve(0)
+      })
+
+      const felix = new FixitFelix(inputsWithSkipDraft, nonDraftPRContext)
+      const result = await felix.run()
+
+      // Should proceed with fixes when PR is not draft
+      expect(result).toBeDefined()
+      expect(mockExec.exec).toHaveBeenCalledWith(
+        'npx',
+        expect.arrayContaining(['prettier', '--write']),
+        expect.any(Object)
+      )
+
+      // Restore environment
+      process.env.GITHUB_TOKEN = originalEnv
+    })
+  })
 })
diff --git a/tests/fixers.test.ts b/tests/fixers.test.ts

Original file line number	Diff line number	Diff line change
`@@ -13,7 +13,8 @@ async function run(): Promise<void> {`
`13`	`13`	`allowedBots: core.getInput('allowed_bots'),`
`14`	`14`	`paths: core.getInput('paths'),`
`15`	`15`	`personalAccessToken: core.getInput('personal_access_token'),`
`16`		`- debug: core.getBooleanInput('debug')`
	`16`	`+ debug: core.getBooleanInput('debug'),`
	`17`	`+ skipDraftPrs: core.getBooleanInput('skip_draft_prs')`
`17`	`18`	`}`
`18`	`19`
`19`	`20`	`const felix = new FixitFelix(inputs, github.context)`
Original file line number	Diff line number	Diff line change
`@@ -8,6 +8,7 @@ export interface FelixInputs {`
`8`	`8`	`paths: string`
`9`	`9`	`personalAccessToken?: string`
`10`	`10`	`debug: boolean`
	`11`	`+ skipDraftPrs: boolean`
`11`	`12`	`}`
`12`	`13`
`13`	`14`	`export interface FelixConfig {`
Original file line number	Diff line number	Diff line change
`@@ -16,7 +16,8 @@ describe('ConfigManager', () => {`
`16`	`16`	`allowedBots: '',`
`17`	`17`	`paths: '',`
`18`	`18`	`personalAccessToken: '',`
`19`		`- debug: false`
	`19`	`+ debug: false,`
	`20`	`+ skipDraftPrs: false`
`20`	`21`	`}`
`21`	`22`
`22`	`23`	`beforeEach(() => {`