- introduce support for specifying labels which will ignore PRs from being included in the changelog

- please note ignored changelogs can be still included i the changelog via the according placeholder
- fix count for categorizedPrs

__tests__/releaseNotesBuilder.test.ts

@@ -87,5 +87,26 @@ it('Should fill `template` placeholders', async () => {
 
   const changeLog = await releaseNotesBuilder.build()
   console.log(changeLog)
-  expect(changeLog).toStrictEqual(`## 🧪 Tests\n\n- [CI] Specify Test Case\n   - PR: #10\n\n\n\nmikepenz\nrelease-changelog-builder-action\nv0.0.1\nv0.0.3\n1\n0`)
+  expect(changeLog).toStrictEqual(`## 🧪 Tests\n\n- [CI] Specify Test Case\n   - PR: #10\n\n\n\n\nmikepenz\nrelease-changelog-builder-action\nv0.0.1\nv0.0.3\n1\n0\n0`)
+})
+
+it('Should fill `template` placeholders, ignore', async () => {
+  jest.setTimeout(180000)
+
+  const configuration = resolveConfiguration('', 'configs_test/configuration_empty_all_placeholders.json')
+  const releaseNotesBuilder = new ReleaseNotesBuilder(
+    null,
+    '.',
+    'mikepenz',
+    'release-changelog-builder-action',
+    'v0.9.1',
+    'v0.9.5',
+    false,
+    false,
+    configuration
+  )
+
+  const changeLog = await releaseNotesBuilder.build()
+  console.log(changeLog)
+  expect(changeLog).toStrictEqual(`## 🚀 Features\n\n- Enhance sorting by using proper semver\n   - PR: #51\n\n## 🧪 Tests\n\n- Improve test cases\n   - PR: #49\n\n\n- Bump @types/node from 14.11.8 to 14.11.10\n   - PR: #47\n- Adjust code to move fromTag resolving to main.ts\n   - PR: #48\n- dev -> main\n   - PR: #52\n- Update package.json to updated description\n   - PR: #53\n- dev -> main\n   - PR: #54\n\n- New additional placeholders for \`template\` and \`empty_template\`\n   - PR: #50\n\nmikepenz\nrelease-changelog-builder-action\nv0.9.1\nv0.9.5\n2\n5\n1`)
 })

configs_test/configuration_empty_all_placeholders.json

@@ -1,4 +1,4 @@
 {
-    "template": "${{CHANGELOG}}\n${{UNCATEGORIZED}}\n${{OWNER}}\n${{REPO}}\n${{FROM_TAG}}\n${{TO_TAG}}\n${{CATEGORIZED_COUNT}}\n${{UNCATEGORIZED_COUNT}}",
+    "template": "${{CHANGELOG}}\n${{UNCATEGORIZED}}\n${{IGNORED}}\n${{OWNER}}\n${{REPO}}\n${{FROM_TAG}}\n${{TO_TAG}}\n${{CATEGORIZED_COUNT}}\n${{UNCATEGORIZED_COUNT}}\n${{IGNORED_COUNT}}",
     "empty_template": "${{OWNER}}\n${{REPO}}\n${{FROM_TAG}}\n${{TO_TAG}}"
 }

src/configuration.ts

@@ -8,6 +8,7 @@ export interface Configuration {
   pr_template: string
   empty_template: string
   categories: Category[]
+  ignore_labels: string[]
   transformers: Transformer[]
   tag_resolver: TagResolver
 }
@@ -49,6 +50,7 @@ export const DefaultConfiguration: Configuration = {
       labels: ['test']
     }
   ], // the categories to support for the ordering
+  ignore_labels: [ "ignore" ], // list of lables being ignored from the changelog
   transformers: [], // transformers to apply on the PR description according to the `pr_template`
   tag_resolver: {
     // defines the logic on how to resolve the previous tag, only relevant if `fromTag` is not specified

src/transform.ts

@@ -42,25 +42,34 @@ export function buildChangelog(
   // bring PRs into the order of categories
   const categorized = new Map<Category, string[]>()
   const categories = config.categories || DefaultConfiguration.categories
+  const ignoredLabels = config.ignore_labels || DefaultConfiguration.ignore_labels
+  
   for (const category of categories) {
     categorized.set(category, [])
   }
+  
   const categorizedPrs: string[] = []
-  const uncategorized: string[] = []
+  const ignoredPrs: string[] = []
+  const uncategorizedPrs: string[] = []
 
   // bring elements in order
   for (const [pr, body] of transformedMap) {
-    let matched = false
+    if (haveCommonElements(ignoredLabels, pr.labels)) {
+      ignoredPrs.push(body)
+      continue
+    }
 
+    let matched = false
     for (const [category, pullRequests] of categorized) {
       if (haveCommonElements(category.labels, pr.labels)) {
         pullRequests.push(body)
         matched = true
+        break
       }
     }
     
     if (!matched) {
-      uncategorized.push(body)
+      uncategorizedPrs.push(body)
     } else {
       categorizedPrs.push(body)
     }
@@ -81,14 +90,22 @@ export function buildChangelog(
       changelog = `${changelog}\n`
     }
   }
-  core.info(`✒️ Wrote ${categorized.size} categorized pull requests down`)
+  core.info(`✒️ Wrote ${categorizedPrs.length} categorized pull requests down`)
 
   let changelogUncategorized = ''
-  for (const pr of uncategorized) {
+  for (const pr of uncategorizedPrs) {
     changelogUncategorized = `${changelogUncategorized + pr}\n`
   }
   core.info(
-    `✒️ Wrote ${uncategorized.length} non categorized pull requests down`
+    `✒️ Wrote ${uncategorizedPrs.length} non categorized pull requests down`
+  )
+
+  let changelogIgnored = ''
+  for (const pr of ignoredPrs) {
+    changelogIgnored = `${changelogIgnored + pr}\n`
+  }
+  core.info(
+    `✒️ Wrote ${ignoredPrs.length} ignored pull requests down`
   )
 
   // fill template
@@ -101,6 +118,10 @@ export function buildChangelog(
     '${{UNCATEGORIZED}}',
     changelogUncategorized
   )
+  transformedChangelog = transformedChangelog.replace(
+    '${{IGNORED}}',
+    changelogIgnored
+  )
 
   // fill other placeholders
   transformedChangelog = transformedChangelog.replace(
@@ -109,7 +130,11 @@ export function buildChangelog(
   )
   transformedChangelog = transformedChangelog.replace(
     '${{UNCATEGORIZED_COUNT}}',
-    uncategorized.length.toString()
+    uncategorizedPrs.length.toString()
+  )
+  transformedChangelog = transformedChangelog.replace(
+    '${{IGNORED_COUNT}}',
+    ignoredPrs.length.toString()
   )
   transformedChangelog = fillAdditionalPlaceholders(
     transformedChangelog,