Merge pull request #66 from luoxi/master

add conditions, checking title

auto-merge.example.yml

@@ -46,3 +46,6 @@ blockingLabels:
 # all of these labels are attached to a pull request.
 requiredLabels:
 - merge
+
+# Automatic merges will be blocked if there is a match between the regular expression and title
+blockingTitleRegex: '\bwip\b'

src/conditions/blockingTitle.ts

@@ -0,0 +1,26 @@
+import { ConditionConfig } from './../config'
+import { PullRequestInfo } from '../models'
+import { ConditionResult } from '../condition'
+
+export default function doesNotHaveBlockingTitle (
+  config: ConditionConfig,
+  pullRequestInfo: PullRequestInfo
+): ConditionResult {
+  if (config.blockingTitleRegex === undefined) {
+    return {
+      status: 'success'
+    }
+  }
+
+  const regexObj = new RegExp(config.blockingTitleRegex, 'i')
+
+  if (regexObj.test(pullRequestInfo.title)) {
+    return {
+      status: 'fail',
+      message: `Blocking words are found in title (${ pullRequestInfo.title })`
+    }
+  }
+  return {
+    status: 'success'
+  }
+}

src/conditions/index.ts

@@ -6,6 +6,7 @@ import blockingLabels from './blockingLabels'
 import blockingChecks from './blockingChecks'
 import minimumApprovals from './minimumApprovals'
 import maximumChangesRequested from './maximumChangesRequested'
+import blockingTitle from './blockingTitle'
 import { keysOf } from '../utils'
 
 export const conditions = {
@@ -15,7 +16,8 @@ export const conditions = {
   blockingLabels,
   minimumApprovals,
   maximumChangesRequested,
-  blockingChecks
+  blockingChecks,
+  blockingTitle
 }
 
 export type Conditions = typeof conditions

src/config.ts

@@ -29,7 +29,8 @@ export type ConditionConfig = {
   minApprovals: { [key in CommentAuthorAssociation]?: number },
   maxRequestedChanges: { [key in CommentAuthorAssociation]?: number },
   requiredLabels: string[],
-  blockingLabels: string[]
+  blockingLabels: string[],
+  blockingTitleRegex: string | undefined
 }
 
 export type Config = {
@@ -46,7 +47,8 @@ export const defaultRuleConfig: ConditionConfig = {
     NONE: 0
   },
   blockingLabels: [],
-  requiredLabels: []
+  requiredLabels: [],
+  blockingTitleRegex: undefined
 }
 
 export const defaultConfig: Config = {
@@ -71,7 +73,8 @@ const conditionConfigDecoder: Decoder<ConditionConfig> = object({
   minApprovals: reviewConfigDecover,
   maxRequestedChanges: reviewConfigDecover,
   requiredLabels: array(string()),
-  blockingLabels: array(string())
+  blockingLabels: array(string()),
+  blockingTitleRegex: optional(string())
 })
 
 const configDecoder: Decoder<Config> = object({
@@ -80,6 +83,7 @@ const configDecoder: Decoder<Config> = object({
   maxRequestedChanges: reviewConfigDecover,
   requiredLabels: array(string()),
   blockingLabels: array(string()),
+  blockingTitleRegex: optional(string()),
   updateBranch: boolean(),
   deleteBranchAfterMerge: boolean(),
   mergeMethod: oneOf(

src/github-models.ts

@@ -45,6 +45,7 @@ export interface PullRequestQueryResult {
           name: string
         }>
       },
+      title: string,
       authorAssociation: CommentAuthorAssociation,
       baseRef: {
         repository: {

src/pull-request-query.ts

@@ -35,6 +35,7 @@ export async function queryPullRequest (github: Context['github'], { owner, repo
               name
             }
           }
+          title
           authorAssociation
           baseRef {
             repository {

test/conditions/blockingTitle.test.ts

@@ -0,0 +1,38 @@
+import blockingTitle from '../../src/conditions/blockingTitle'
+import { createPullRequestInfo, createConditionConfig } from '../mock'
+
+describe('blockingTitle', () => {
+  it('returns success if with default configuration(undefined)', async () => {
+    const result = blockingTitle(
+      createConditionConfig(),
+      createPullRequestInfo({
+        title: '[WIP] help needed'
+      })
+    )
+    expect(result.status).toBe('success')
+  })
+
+  it('returns success if there is a match in title', async () => {
+    const result = blockingTitle(
+      createConditionConfig({
+        blockingTitleRegex: 'wip'
+      }),
+      createPullRequestInfo({
+        title: 'Add some feature'
+      })
+    )
+    expect(result.status).toBe('success')
+  })
+
+  it('returns fail if there is not a match in title', async () => {
+    const result = blockingTitle(
+      createConditionConfig({
+        blockingTitleRegex: 'wip'
+      }),
+      createPullRequestInfo({
+        title: '[WIP] help needed'
+      })
+    )
+    expect(result.status).toBe('fail')
+  })
+})

test/mock.ts

@@ -54,7 +54,8 @@ export const defaultPullRequestInfo: PullRequestInfo = {
       nodes: []
     }
   },
-  checkRuns: []
+  checkRuns: [],
+  title: 'Add some feature'
 }
 
 export function createPullRequestInfo (pullRequestInfo?: Partial<PullRequestInfo>): PullRequestInfo {