Add config option for pull-request-limit

bin/generate-fixtures.js

@@ -86,6 +86,7 @@ for (const repo of repos) {
         withPullRequestURL: true,
         withBaseRefName: true,
         withHeadRefName: true,
+        pullRequestLimit: 5,
       },
     })
   )

dist/index.js

@@ -142563,6 +142563,7 @@ const findCommitsWithAssociatedPullRequestsQuery = /* GraphQL */ `
     $after: String
     $withBaseRefName: Boolean!
     $withHeadRefName: Boolean!
+    $pullRequestLimit: Int!
   ) {
     repository(name: $name, owner: $owner) {
       object(expression: $targetCommitish) {
@@ -142583,7 +142584,7 @@ const findCommitsWithAssociatedPullRequestsQuery = /* GraphQL */ `
                   login
                 }
               }
-              associatedPullRequests(first: 5) {
+              associatedPullRequests(first: $pullRequestLimit) {
                 nodes {
                   title
                   number
@@ -142630,6 +142631,7 @@ const findCommitsWithAssociatedPullRequests = async ({
     withPullRequestURL: config['change-template'].includes('$URL'),
     withBaseRefName: config['change-template'].includes('$BASE_REF_NAME'),
     withHeadRefName: config['change-template'].includes('$HEAD_REF_NAME'),
+    pullRequestLimit: config['pull-request-limit'],
   }
   const includePaths = config['include-paths']
   const dataPath = ['repository', 'object', 'history']
@@ -142824,6 +142826,7 @@ const DEFAULT_CONFIG = Object.freeze({
   latest: 'true',
   'filter-by-commitish': false,
   commitish: '',
+  'pull-request-limit': 5,
   'category-template': `## $TITLE`,
   header: '',
   footer: '',
@@ -143529,6 +143532,11 @@ const schema = (context) => {
 
       commitish: Joi.string().allow('').default(DEFAULT_CONFIG['commitish']),
 
+      'pull-request-limit': Joi.number()
+        .positive()
+        .integer()
+        .default(DEFAULT_CONFIG['pull-request-limit']),
+
       replacers: Joi.array()
         .items(
           Joi.object().keys({

lib/commits.js

@@ -40,6 +40,7 @@ const findCommitsWithAssociatedPullRequestsQuery = /* GraphQL */ `
     $after: String
     $withBaseRefName: Boolean!
     $withHeadRefName: Boolean!
+    $pullRequestLimit: Int!
   ) {
     repository(name: $name, owner: $owner) {
       object(expression: $targetCommitish) {
@@ -60,7 +61,7 @@ const findCommitsWithAssociatedPullRequestsQuery = /* GraphQL */ `
                   login
                 }
               }
-              associatedPullRequests(first: 5) {
+              associatedPullRequests(first: $pullRequestLimit) {
                 nodes {
                   title
                   number
@@ -107,6 +108,7 @@ const findCommitsWithAssociatedPullRequests = async ({
     withPullRequestURL: config['change-template'].includes('$URL'),
     withBaseRefName: config['change-template'].includes('$BASE_REF_NAME'),
     withHeadRefName: config['change-template'].includes('$HEAD_REF_NAME'),
+    pullRequestLimit: config['pull-request-limit'],
   }
   const includePaths = config['include-paths']
   const dataPath = ['repository', 'object', 'history']

lib/default-config.js

@@ -30,6 +30,7 @@ const DEFAULT_CONFIG = Object.freeze({
   latest: 'true',
   'filter-by-commitish': false,
   commitish: '',
+  'pull-request-limit': 5,
   'category-template': `## $TITLE`,
   header: '',
   footer: '',

lib/schema.js

@@ -95,6 +95,11 @@ const schema = (context) => {
 
       commitish: Joi.string().allow('').default(DEFAULT_CONFIG['commitish']),
 
+      'pull-request-limit': Joi.number()
+        .positive()
+        .integer()
+        .default(DEFAULT_CONFIG['pull-request-limit']),
+
       replacers: Joi.array()
         .items(
           Joi.object().keys({

test/fixtures/config/config-with-pull-request-limit.yml

@@ -0,0 +1,2 @@
+template: '$CHANGES'
+pull-request-limit: 34

test/index.test.js

@@ -2424,6 +2424,78 @@ describe('release-drafter', () => {
     })
   })
 
+  describe('with pull-request-limit config', () => {
+    it('uses the correct default when not specified', async () => {
+      getConfigMock()
+
+      nock('https://api.github.com')
+        .post('/graphql', (body) => {
+          if (
+            body.query.includes('query findCommitsWithAssociatedPullRequests')
+          ) {
+            expect(body.variables.pullRequestLimit).toBe(5)
+            return true
+          }
+          return false
+        })
+        .reply(200, graphqlCommitsNoPRsPayload)
+
+      nock('https://api.github.com')
+        .get(
+          '/repos/toolmantim/release-drafter-test-project/releases?per_page=100'
+        )
+        .reply(200, [])
+
+      nock('https://api.github.com')
+        .post('/repos/toolmantim/release-drafter-test-project/releases')
+        .reply(200, releasePayload)
+
+      const payload = pushPayload
+
+      await probot.receive({
+        name: 'push',
+        payload,
+      })
+
+      expect.assertions(1)
+    })
+
+    it('requests the specified number of associated PRs', async () => {
+      getConfigMock('config-with-pull-request-limit.yml')
+
+      nock('https://api.github.com')
+        .post('/graphql', (body) => {
+          if (
+            body.query.includes('query findCommitsWithAssociatedPullRequests')
+          ) {
+            expect(body.variables.pullRequestLimit).toBe(34)
+            return true
+          }
+          return false
+        })
+        .reply(200, graphqlCommitsNoPRsPayload)
+
+      nock('https://api.github.com')
+        .get(
+          '/repos/toolmantim/release-drafter-test-project/releases?per_page=100'
+        )
+        .reply(200, [])
+
+      nock('https://api.github.com')
+        .post('/repos/toolmantim/release-drafter-test-project/releases')
+        .reply(200, releasePayload)
+
+      const payload = pushPayload
+
+      await probot.receive({
+        name: 'push',
+        payload,
+      })
+
+      expect.assertions(1)
+    })
+  })
+
   describe('config error handling', () => {
     it('schema error', async () => {
       getConfigMock('config-with-schema-error.yml')

test/schema.test.js

@@ -20,6 +20,7 @@ const validConfigs = [
   [{ template, header: 'I am on top' }],
   [{ template, footer: 'I am on bottm' }],
   [{ template, header: 'I am on top', footer: 'I am on bottm' }],
+  [{ template, 'pull-request-limit': 49 }],
 ]
 
 const invalidConfigs = [
@@ -53,6 +54,7 @@ const invalidConfigs = [
   ],
   [{ replacers: [{ search: '123', replace: 123 }] }, 'must be a string'],
   [{ commitish: false }, 'must be a string'],
+  [{ 'pull-request-limit': 'forty nine' }, 'must be a number'],
 ]
 
 describe('schema', () => {