Add number in the list of properties supported for rules

README.md

@@ -422,6 +422,7 @@ Table of descriptions for the `configuration.json` options to configure the resu
 | category.labels             | An array of labels, to match pull request labels against. If any PR label matches any category label, the pull request will show up under this category. (See `exhaustive` to change this)                                         |
 | category.exclude_labels     | Similar to `labels`, an array of labels to match PRs against, but if a match occurs the PR is excluded from this category.                                                                                                         |
 | category.exhaustive         | Will require all labels defined within this category to be present on the matching PR.                                                                                                                                             |
+| category.exclusive_rules    | Will require all rules defined within this category to be valid on the matching PR. If not defined, defaults to the value of `exhaustive`                                                                                                                                             |
 | category.empty_content      | If the category has no matching PRs, this content will be used. When not set, the category will be skipped in the changelog.                                                                                                       |
 | category.rules              | An array of `rules` used to match PRs against. Any match will include the PR. (See `exhaustive` to change this)                                                                                                                    |
 | category.rules.pattern      | A `regex` pattern to match the property value towards. Uses `RegExp.test("val")`                                                                                                                                                   |

__tests__/transform.test.ts

@@ -310,6 +310,46 @@ pullRequestsWithLabels.push(
   }
 )
 
+const openPullRequestsWithLabels: PullRequestInfo[] = []
+openPullRequestsWithLabels.push(
+  {
+  number: 6,
+  title: 'Still pending open pull request (Current)',
+  htmlURL: '',
+  baseBranch: '',
+  createdAt: moment(),
+  mergedAt: moment(),
+  mergeCommitSha: 'sha1',
+  author: 'Mike',
+  repoName: 'test-repo',
+  labels: new Set<string>().add('feature'),
+  milestone: '',
+  body: 'Some fancy body message',
+  assignees: [],
+  requestedReviewers: [],
+  approvedReviewers: [],
+  status: 'open'
+},
+{
+  number: 7,
+  title: 'Still pending open pull request',
+  htmlURL: '',
+  baseBranch: '',
+  createdAt: moment(),
+  mergedAt: moment(),
+  mergeCommitSha: 'sha1',
+  author: 'Mike',
+  repoName: 'test-repo',
+  labels: new Set<string>().add('feature'),
+  milestone: '',
+  body: 'Some fancy body message',
+  assignees: [],
+  requestedReviewers: [],
+  approvedReviewers: [],
+  status: 'open'
+}
+)
+
 it('Match multiple labels exhaustive for category', async () => {
   const customConfig = Object.assign({}, DefaultConfiguration)
   customConfig.categories = [
@@ -534,8 +574,46 @@ it('Use Rules to get all open PRs in a Category.', async () => {
       ]
     }
   ]
+  expect(buildChangelogTest(customConfig, prs)).toStrictEqual(`## Open PRs only\n\n- Still pending open pull request\n   - PR: #6\n\n`)
+})
+
+
+it('Use Rules to get current open PR and merged categorised.', async () => {
+  let prs = Array.from(pullRequestsWithLabels)
+  prs = prs.concat(Array.from(openPullRequestsWithLabels))
+
+  const customConfig = Object.assign({}, DefaultConfiguration)
+  customConfig.categories = [
+    {
+      title: '## 🚀 Features',
+      labels: ['Feature'],
+      rules: [
+        {
+          pattern: '6',
+          on_property: 'number'
+        },
+        {
+          pattern: 'merged',
+          on_property: 'status'
+        }
+      ],
+      exhaustive: true,
+      exclusive_rules: false
+    },{
+      title: '## 🐛 Issues',
+      labels: ['Issue'],
+      rules: [
+        {
+          pattern: 'merged',
+          on_property: 'status'
+        }
+      ],
+      exhaustive: true
+    }
+  ]
+
   expect(buildChangelogTest(customConfig, prs)).toStrictEqual(
-    `## Open PRs only\n\n- Still pending open pull request\n   - PR: #6\n\n`
+    `## 🚀 Features\n\n- [ABC-1234] - this is a PR 1 title message\n   - PR: #1\n- Still pending open pull request (Current)\n   - PR: #6\n- [ABC-1234] - this is a PR 3 title message\n   - PR: #3\n\n## 🐛 Issues\n\n- [ABC-4321] - this is a PR 2 title message\n   - PR: #2\n- [ABC-1234] - this is a PR 3 title message\n   - PR: #3\n\n`
   )
 })
 
@@ -571,6 +649,7 @@ it('Use Rules to get all open PRs in one Category and merged categorised.', asyn
   )
 })
 
+
 function buildChangelogTest(config: Configuration, prs: PullRequestInfo[]): string {
   return buildChangelog(DefaultDiffInfo, prs, {
     owner: 'mikepenz',
@@ -585,4 +664,4 @@ function buildChangelogTest(config: Configuration, prs: PullRequestInfo[]): stri
     commitMode: false,
     configuration: config
   })
-}
+}

src/configuration.ts

@@ -23,14 +23,16 @@ export interface Category {
   labels?: string[] // labels to associate PRs to this category
   exclude_labels?: string[] // if an exclude label is detected, the PR will be excluded from this category
   rules?: Rule[] // rules to associate PRs to this category
-  exhaustive?: boolean // requires all labels AND/OR rules to be present in the PR
+  exhaustive?: boolean // requires all labels to be present in the PR
+  exclusive_rules?: boolean // requires all rules to be present in the PR (if not set, defaults to exhaustive value)
   empty_content?: string // if the category has no matching PRs, this content will be used. If not set, the category will be skipped in the changelog.
 }
 
 /**
  * Defines the properties of the PullRequestInfo useable in different configurations
  */
 export type Property =
+  | 'number'
   | 'title'
   | 'branch'
   | 'author'

src/pullRequests.ts

@@ -212,14 +212,16 @@ export function compare(a: PullRequestInfo, b: PullRequestInfo, sort: Sort): num
  * Helper function to retrieve a property from the PullRequestInfo
  */
 export function retrieveProperty(pr: PullRequestInfo, property: Property, useCase: string): string {
-  let value: string | Set<string> | string[] | undefined = pr[property]
+  let value: string | number | Set<string> | string[] | undefined = pr[property]
   if (value === undefined) {
     core.warning(`⚠️ the provided property '${property}' for \`${useCase}\` is not valid. Fallback to 'body'`)
     value = pr['body']
   } else if (value instanceof Set) {
     value = Array.from(value).join(',') // join into single string
   } else if (Array.isArray(value)) {
     value = value.join(',') // join into single string
+  } else {
+    value = value.toString()
   }
   return value
 }

src/transform.ts

@@ -133,8 +133,12 @@ export function buildChangelog(diffInfo: DiffInfo, prs: PullRequestInfo[], optio
             pr.labels
           )
         }
+        let exclusive_rules = true
+        if (category.exclusive_rules !== undefined) {
+          exclusive_rules = category.exclusive_rules
+        }
         if (matched && category.rules !== undefined) {
-          matched = matchesRules(category.rules, pr, true)
+          matched = matchesRules(category.rules, pr, exclusive_rules)
         }
       } else {
         // if not exhaustive, do individual matches
@@ -145,9 +149,13 @@ export function buildChangelog(diffInfo: DiffInfo, prs: PullRequestInfo[], optio
             pr.labels
           )
         }
+        let exclusive_rules = false
+        if (category.exclusive_rules !== undefined) {
+          exclusive_rules = category.exclusive_rules
+        }
         if (!matched && category.rules !== undefined) {
           // if no label did apply, check if any rule applies
-          matched = matchesRules(category.rules, pr, false)
+          matched = matchesRules(category.rules, pr, exclusive_rules)
         }
       }
       if (matched) {