Add ability to add multiple issues and prs (#43)

Author: joachimdalen

.azext/changelog-cache.json

@@ -86,6 +86,13 @@
     }
   ],
   "pullRequests": [
+    {
+      "id": 816815655,
+      "number": 43,
+      "submitter": "joachimdalen",
+      "title": "Add ability to add multiple issues and prs",
+      "url": "https://github.com/joachimdalen/azext/pull/43"
+    },
     {
       "id": 816809018,
       "number": 42,

.azext/changelog.json

@@ -20,6 +20,11 @@
             "description": "Added the ability to define custom sections",
             "issue": 40,
             "pullRequest": 42
+          },
+          {
+            "type": "feature",
+            "description": "Added the ability to add multiple issues and pull requests per change",
+            "pullRequest": 43
           }
         ]
       }

CHANGELOG.md

@@ -8,14 +8,18 @@
 
 ---
 
-### 🚀 Features (1)
+### 🚀 Features (2)
 
 #### `[email protected]`
 
 - Added the ability to define custom sections
+
   - Suggested in [GH#40 - Add ability to set a "Known issues" section on root](https://github.com/joachimdalen/azext/issues/40)
   - Added in [PR#42 - Add ability to define custom information sections at root level](https://github.com/joachimdalen/azext/pull/42)
 
+- Added the ability to add multiple issues and pull requests per change
+  - Added in [PR#43 - Add ability to add multiple issues and prs](https://github.com/joachimdalen/azext/pull/43)
+
 ---
 
 ## 0.4.0 (2022-01-05)

schemas/v1/changelog-schema.json

@@ -103,9 +103,17 @@
                               "description": "An explanation about the purpose of this instance."
                             },
                             "issue": {
-                              "type": "integer",
                               "title": "GitHub issue number",
-                              "description": "The GitHub issue number issue number of a releated GitHub issue"
+                              "description": "The GitHub issue number issue number of a releated GitHub issue",
+                              "oneOf": [
+                                { "type": "integer" },
+                                {
+                                  "type": "array",
+                                  "items": {
+                                    "type": "number"
+                                  }
+                                }
+                              ]
                             },
                             "pullRequest": {
                               "type": "integer",

src/modules/changelog/changelog-service.ts

@@ -145,7 +145,7 @@ class ChangelogService {
     if (cache.issues) {
       const allModules = getChangesForAllDefinition(changelog);
       const issueIds = allModules
-        .map((x) => x.issue)
+        .flatMap((x) => (Array.isArray(x.issue) ? x.issue : [x.issue]))
         .filter(isNumber)
         .filter(distinct)
         .filter((y) => !cache.issues?.some((x) => x.number === y));
@@ -168,7 +168,9 @@ class ChangelogService {
       const allModules = getChangesForAllDefinition(changelog);
 
       const prIds = allModules
-        .map((x) => x.pullRequest)
+        .flatMap((x) =>
+          Array.isArray(x.pullRequest) ? x.pullRequest : [x.pullRequest]
+        )
         .filter(isNumber)
         .filter(distinct)
         .filter((y) => !cache.pullRequests?.some((x) => x.number === y));

src/modules/changelog/generator.ts

@@ -134,25 +134,80 @@ class Generator {
     return typeMap;
   }
 
+  public getGithubIssue(
+    issueId: number,
+    resourceLink: TypeResourcePrefix,
+    context: GeneratorContext,
+    removePrefix: boolean
+  ) {
+    const ghIssue = context.issues.get(issueId);
+
+    if (ghIssue) {
+      const link = this.getIssueLink(ghIssue, context.config);
+      return removePrefix ? link : `${resourceLink.issue} ${link}`;
+    }
+
+    return undefined;
+  }
+
+  public getGithubPr(
+    prId: number,
+    resourceLink: TypeResourcePrefix,
+    context: GeneratorContext,
+    removePrefix: boolean
+  ) {
+    const ghPr = context.pullRequests.get(prId);
+
+    if (ghPr) {
+      const link = this.getPrLink(ghPr, context.config);
+      return removePrefix ? link : `${resourceLink.pullRequest} ${link}`;
+    }
+
+    return undefined;
+  }
+
   public getGithubMeta(entry: ChangelogEntry, context: GeneratorContext) {
     const builder = new MarkdownBuilder();
     const resourceLink = this.getResourceLink(context.config, entry.type);
+
     if (entry.issue !== undefined) {
-      const ghIssue = context.issues.get(entry.issue);
+      const isMultiple = Array.isArray(entry.issue);
+      const issueIds: number[] = Array.isArray(entry.issue)
+        ? entry.issue
+        : [entry.issue];
 
-      if (ghIssue) {
-        builder.addSubListItem(
-          `${resourceLink.issue} ${this.getIssueLink(ghIssue, context.config)}`
+      if (isMultiple && resourceLink?.issue) {
+        builder.addSubListItem(resourceLink.issue);
+      }
+
+      for (const issueId of issueIds) {
+        const issue = this.getGithubIssue(
+          issueId,
+          resourceLink,
+          context,
+          isMultiple
         );
+        if (issue) {
+          builder.addSubListItem(issue, isMultiple);
+        }
       }
     }
 
     if (entry.pullRequest !== undefined) {
-      const ghPr = context.pullRequests.get(entry.pullRequest);
-      if (ghPr) {
-        builder.addSubListItem(
-          `${resourceLink.pullRequest} ${this.getPrLink(ghPr, context.config)}`
-        );
+      const isMultiple = Array.isArray(entry.pullRequest);
+      const prIds: number[] = Array.isArray(entry.pullRequest)
+        ? entry.pullRequest
+        : [entry.pullRequest];
+
+      if (isMultiple && resourceLink?.pullRequest) {
+        builder.addSubListItem(resourceLink.pullRequest);
+      }
+
+      for (const prId of prIds) {
+        const pr = this.getGithubPr(prId, resourceLink, context, isMultiple);
+        if (pr) {
+          builder.addSubListItem(pr, isMultiple);
+        }
       }
     }
 

src/modules/changelog/markdown-builder.ts

@@ -52,8 +52,8 @@ export default class MarkdownBuilder {
   addListItem(text: string) {
     this.addRaw(`- ${text}`);
   }
-  addSubListItem(text: string) {
-    this.addRaw(`\t - ${text}`);
+  addSubListItem(text: string, double = false) {
+    this.addRaw(double ? `\t\t - ${text}` : `\t - ${text}`);
   }
   addRaw(text: string) {
     this._content = this._content + text + EOL;

src/modules/changelog/models/changelog-entry.ts

@@ -1,6 +1,6 @@
 export default interface ChangelogEntry {
   type: string;
-  issue?: number;
-  pullRequest?: number;
+  issue?: number | number[];
+  pullRequest?: number | number[];
   description: string;
 }