feat(democrat): Allow pull pull request parameters to be configurable (…

…#32)

.github/dependabot.yml

@@ -1,9 +1,6 @@
 version: 2
 updates:
-  # Enable version updates for npm
   - package-ecosystem: 'npm'
-    # Look for `package.json` and `lock` files in the `root` directory
     directory: '/'
-    # Check the npm registry for updates every day (weekdays)
     schedule:
-      interval: 'daily'
+      interval: 'weekly'

.github/workflows/test.yaml

@@ -23,7 +23,14 @@ jobs:
       - uses: actions/checkout@v2
       - run: npm install
       - run: npm run all
+      - uses: ./
+        with:
+          githubToken: ${{ secrets.GITHUB_TOKEN }}
       - uses: ./
         with:
           githubToken: ${{ secrets.GITHUB_TOKEN }}
           dryRun: true
+          prMinimumReviewScore: 1
+          prMaturity: 24
+          prMarkAsMegeableLabel: ready
+          prTargetBranch: main

README.md

@@ -1,9 +1,7 @@
 <br />
 <p align="center">
-  <a href="#">
-    <img src="./logo.svg" alt="Logo" width="100" height="67">
-    <!-- logomakr.com/6hgBHr && picsvg.com -->
-  </a>
+  <img src="./logo.svg" alt="Logo" width="100" height="67">
+  <!-- logomakr.com/6hgBHr && picsvg.com -->
 
   <h3 align="center">Github Democrat Action</h3>
 
@@ -62,16 +60,22 @@ jobs:
       - uses: deuzu/github-democrat-action
         with:
           githubToken: ${{ secrets.GITHUB_TOKEN }} # GitHub automatically creates the GITHUB_TOKEN secret
-          # dryRun: true # the Github democrat will process but won't merge pull requests
+          # dryRun: true
+          # prMinimumReviewScore: 1
+          # prMaturity: 24
+          # prMarkAsMegeableLabel: ready
+          # prTargetBranch: main
 ```
 
-The job will hunt pull requests and merge ones that fit the following constraints:
+Cf. [./action.yaml](./action.yaml) for action inputs.
+
+The job will look for open pull requests and merge ones that satisfy the following constraints (configurable):
 - receive more than half of the majority vote cast (votes are review approves and request changes)
-- is ready to be merged (with a `ready` label)
-- is mature (last commit is older than 24h)
-- target is the `main` branch
+- is ready to be merged (with a configurable label)
+- is mature (last commit is older than a configurable delay)
+- target is the configured branch
 
-To avoid fraud, it's advised to add protections on the main branch:
+To avoid fraud, it's advised to add protections on the target branch:
 - [X] Require pull request reviews before merging
 - [X] Dismiss stale pull request approvals when new commits are pushed
 - [X] Require status checks to pass before merging

__tests__/democrat.test.ts

@@ -35,7 +35,14 @@ describe('Democrat', () => {
   })
 
   test('Enforce democracy', async () => {
-    const democrat = new Democrat({ token: '12345', owner: 'org', repo: 'repo', dryRun: false, logFunction: () => {} })
+    const democratParameters = { token: '12345abc', owner: 'org', repo: 'repo', dryRun: false, logFunction: () => {} }
+    const pullRequestParameters = {
+      minimumReviewScore: 1,
+      maturity: 24,
+      markAsMergeableLabel: 'ready',
+      targetBranch: 'main',
+    }
+    const democrat = new Democrat(democratParameters, pullRequestParameters)
     await democrat.enforceDemocracy()
 
     expect(pullListMock).toHaveBeenCalledTimes(1)
@@ -45,7 +52,14 @@ describe('Democrat', () => {
   })
 
   test('Enforce democracy - DryRun', async () => {
-    const democrat = new Democrat({ token: '12345', owner: 'org', repo: 'repo', dryRun: true, logFunction: () => {} })
+    const democratParameters = { token: '12345abc', owner: 'org', repo: 'repo', dryRun: true, logFunction: () => {} }
+    const pullRequestParameters = {
+      minimumReviewScore: 1,
+      maturity: 24,
+      markAsMergeableLabel: 'ready',
+      targetBranch: 'main',
+    }
+    const democrat = new Democrat(democratParameters, pullRequestParameters)
     await democrat.enforceDemocracy()
 
     expect(pullListMock).toHaveBeenCalledTimes(1)

action.yml

@@ -14,7 +14,22 @@ inputs:
     required: false
     description: "When `dryRun: true` the Github democrat won't merge any pull requests"
     default: false
-
+  prMinimumReviewScore:
+    required: false
+    description: The minimum pull request review score needed to be eligible for merge (approves +1, request changes -1)
+    default: 1
+  prMaturity:
+    required: false
+    description: The delay (in hours) needed before a pull request is eligible for merge
+    default: 24
+  prMarkAsMegeableLabel:
+    required: false
+    description: The pull request label needed to be eligible for merge
+    default: ready
+  prTargetBranch:
+    required: false
+    description: The pull request target branch
+    default: main
 runs:
   using: node12
   main: dist/index.js

src/democrat.ts

@@ -2,12 +2,21 @@ import * as github from '@actions/github'
 import { GitHub } from '@actions/github/lib/utils'
 import { Endpoints } from '@octokit/types'
 
+type logFunction = (level: string, message: string) => void
+
 export interface DemocratParameters {
   readonly token: string
   readonly owner: string
   readonly repo: string
-  readonly dryRun?: boolean
-  readonly logFunction?: (level: string, message: string) => void
+  readonly dryRun: boolean
+  readonly logFunction: logFunction
+}
+
+export interface PullRequestParameters {
+  readonly minimumReviewScore: number
+  readonly maturity: number
+  readonly markAsMergeableLabel: string
+  readonly targetBranch: string
 }
 
 interface PullCandidate {
@@ -25,15 +34,17 @@ type listReviewsData = Endpoints['GET /repos/{owner}/{repo}/pulls/{pull_number}/
 
 export default class Democrat {
   private democratParameters: DemocratParameters
+  private pullRequestParameters: PullRequestParameters
   private octokit: InstanceType<typeof GitHub>
-  private logger: (level: string, message: string) => void
+  private logger: logFunction
 
-  constructor(democratParameters: DemocratParameters) {
+  constructor(democratParameters: DemocratParameters, pullRequestParameters: PullRequestParameters) {
     this.democratParameters = democratParameters
-    this.octokit = github.getOctokit(democratParameters.token)
+    this.pullRequestParameters = pullRequestParameters
     /* eslint-disable no-console */
     this.logger = democratParameters.logFunction || ((level, message) => console.log(`${level} - ${message}`))
     /* eslint-enable no-console */
+    this.octokit = github.getOctokit(democratParameters.token)
   }
 
   async enforceDemocracy(): Promise<void> {
@@ -44,7 +55,17 @@ export default class Democrat {
     this.logger('info', `${pulls.length} pull request(s) is/are candidate(s) for merge.`)
     const pullsAndReviews = await this.fetchPullDetailsAndReviews(pulls)
     const pullCandidates = this.buildPullCandidates(pullsAndReviews)
-    const electedPullCandidates = pullCandidates.filter(this.validatePullCandidate)
+    const electedPullCandidates = pullCandidates.filter((pull) => {
+      const errors = this.validatePullCandidate(pull)
+
+      if (errors.length > 0) {
+        this.logger('info', `Pull request #${pull.number} did not pass validation. Errors: ${errors.join(', ')}.`)
+
+        return false
+      }
+
+      return true
+    })
     this.logger('info', `${electedPullCandidates.length} pull request(s) left after validation.`)
 
     await this.mergePulls(electedPullCandidates)
@@ -138,14 +159,21 @@ export default class Democrat {
     }
   }
 
-  private validatePullCandidate = (pullCandidate: PullCandidate): boolean => {
-    return (
-      pullCandidate.mergeable &&
-      pullCandidate.reviewScore >= 1 &&
-      (+new Date() - pullCandidate.updatedAt.getTime()) / (1000 * 60 * 60) > 24 &&
-      -1 !== pullCandidate.labels.indexOf('ready') &&
-      'main' === pullCandidate.base
-    )
+  private validatePullCandidate(pullCandidate: PullCandidate): string[] {
+    const errors = []
+    const { minimumReviewScore, maturity, markAsMergeableLabel, targetBranch } = this.pullRequestParameters
+    const lastCommitSinceHours = (+new Date() - pullCandidate.updatedAt.getTime()) / (1000 * 60 * 60)
+    const hasMergeableLabel = -1 !== pullCandidate.labels.indexOf(markAsMergeableLabel)
+
+    pullCandidate.mergeable || errors.push('not mergeable')
+    pullCandidate.reviewScore >= minimumReviewScore || errors.push(`review score too low: ${pullCandidate.reviewScore}`)
+    lastCommitSinceHours > maturity ||
+      errors.push(`not mature enough (last commit ${lastCommitSinceHours.toPrecision(1)}h ago)`)
+    hasMergeableLabel || errors.push(`missing \`${markAsMergeableLabel}\` label`)
+    targetBranch === pullCandidate.base ||
+      errors.push(`wrong target branch: ${pullCandidate.base} instead of ${targetBranch}`)
+
+    return errors
   }
 
   private async mergePulls(pulls: PullCandidate[]): Promise<void[]> {

src/main.ts

@@ -1,22 +1,20 @@
 import dotenv from 'dotenv'
 import * as core from '@actions/core'
 import * as github from '@actions/github'
-import Democrat, { DemocratParameters } from './democrat'
+import Democrat, { DemocratParameters, PullRequestParameters } from './democrat'
 
 dotenv.config()
 
 async function run(): Promise<void> {
   try {
     const context = github.context
-    const token = core.getInput('githubToken') || process.env.GITHUB_TOKEN || ''
     const [owner, repo] = (context.payload.repository?.full_name || process.env.GITHUB_REPOSITORY || '/').split('/')
-    const dryRun = (core.getInput('dryRun') || process.env.DRY_RUN) === 'true'
 
-    const democratParameter: DemocratParameters = {
-      token,
+    const democratParameters: DemocratParameters = {
+      token: core.getInput('githubToken') || process.env.GITHUB_TOKEN || '',
       owner,
       repo,
-      dryRun,
+      dryRun: (core.getInput('dryRun') || process.env.DRY_RUN) === 'true',
       logFunction: (level: string, message: string) => {
         /* eslint-disable @typescript-eslint/no-explicit-any */
         const coreUntyped = core as any
@@ -25,7 +23,14 @@ async function run(): Promise<void> {
       },
     }
 
-    const democrat = new Democrat(democratParameter)
+    const pullRequestParameters: PullRequestParameters = {
+      minimumReviewScore: parseInt(core.getInput('prMinimumReviewScore') || process.env.PR_MINIMUM_REVIEW_SCORE || ''),
+      maturity: parseInt(core.getInput('prMaturity') || process.env.PR_MATURITY || ''),
+      markAsMergeableLabel: core.getInput('prMarkAsMegeableLabel') || process.env.PR_MARK_AS_MERGEABLE_LABEL || '',
+      targetBranch: core.getInput('prTargetBranch') || process.env.PR_TARGET_BRANCH || '',
+    }
+
+    const democrat = new Democrat(democratParameters, pullRequestParameters)
     await democrat.enforceDemocracy()
   } catch (error) {
     core.setFailed(error.message)