Merge pull request #4 from willemduncan/otherSection

Feat: Add option to also output uncategorized PRs

action.yml

@@ -8,6 +8,9 @@ inputs:
   title:
     required: false
     description: Optional title of the changelog
+  other_section_title:
+    required: false
+    description: Optional title for the section containing all non-prefixed pull requests
 outputs:
   version:
     description: The current version

readme.md

@@ -25,10 +25,11 @@ Currently mapped prefixes:
 
 ### Available options
 
-| Name             | Description                                                                                             |
-| ---------------- | ------------------------------------------------------------------------------------------------------- |
-| `title`          | Optional title to use as a heading above the changelog. If not specified, the changelog has no heading. |
-| `update_release` | When set to `true`, will update the current release with the generated release notes. Default `false`.  |
+| Name                  | Description                                                                                                                       |
+| --------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
+| `update_release`      | When set to `true`, will update the current release with the generated release notes. Default `false`.                            |
+| `title`               | Title to use as a heading above the changelog. If not specified, the changelog has no heading.                                    |
+| `other_section_title` | Title to use as heading for section containing all pull requests not in other sections. If not specified, they are not displayed. |
 
 ### Generate a changelog message
 

src/configuration.ts

@@ -0,0 +1,8 @@
+export interface Configuration {
+    /** Main title of the changelog. */
+    title: string | null,
+    /** Explicit section definitions. */
+    sections: { title: string, prefixes: string[] }[],
+    /** If not null, put any items that do not match an explicit section under this title. */
+    otherSectionTitle: string | null
+}

src/createChangelog.ts

@@ -0,0 +1,61 @@
+import * as core from '@actions/core';
+import { Configuration } from './configuration';
+import { Changelog, Issue } from './models';
+
+/**
+ * Create a changelog model from a collection of issues.
+ * @param items The items to use as base collection.
+ */
+export function createChangelog(items: Issue[], config: Configuration): Changelog {
+  core.info(`Create changelog for ${items.length} items.`);
+
+  const result: Changelog = {
+    title: config.title,
+    sections: []
+  };
+
+  const addSection = (title: string, items: { title: string, item: Issue }[]) => {
+    core.info(`Create changelog section '${title}' with ${items.length} items.`);
+    if (items.length > 0) {
+      result.sections.push({ title, items });
+    }
+  };
+
+  config.sections.forEach(s =>
+    addSection(s.title, getItemsByPrefix(items, s.prefixes))
+  );
+
+  if (config.otherSectionTitle) {
+    // Take all items except those already in a section.
+    addSection(config.otherSectionTitle, items
+      .filter(i => !result.sections.some(s => s.items.some(si => si.item === i)))
+      .map(i => ({
+        title: i.title,
+        item: i
+      })));
+  }
+
+  return result;
+}
+
+/**
+ * Filter a collection of issues.
+ * @param items The items to filter.
+ * @param prefixes The prefixes to filter.
+ */
+function getItemsByPrefix(items: Issue[], prefixes: string[]) {
+  const regex = new RegExp(`^(${prefixes.join('|')})?:?\\s+`, 'i');
+  return items
+    // Match with allowed prefixes
+    .map(item => ({
+      data: item,
+      match: regex.exec(item.title)
+    }))
+    // Filter by positive matches.
+    .filter(item => item.match)
+    // Create title without filtered prefix.
+    .map(item => ({
+      title: item.data.title.substring(item.match![0].length),
+      item: item.data
+    }));
+}