Feature/26 introduce idea of pr without issue as part for user defined chapters (#37)

miroslavpojer · web-flow · commit 2146b50d90fb · 2024-01-29T15:31:03.000+01:00
#26 - Introduce the idea of PR without Issue as part of user-defined chapters - introduced logic to work with PR without linked Issues like with Issues - removed code duplication from logic extension "extraction of Release notes" from comments. - fix similar methods to get issues and PR contributors. - improved method `parseChaptersJson` - Added new related test. - Implemented logic to add PR without linking issues to custom chapters. - Added new related test. - Added logic to identify Duplicate mentions of already printed Issues or PR in custom chapters. - Simplified duplicate string as GitHub does not support colors.
diff --git a/README.md b/README.md
@@ -34,6 +34,7 @@ Add the following step to your GitHub workflow (in example are used non-default
     published-at: true
     skip-release-notes-label: 'ignore-in-release'     # changing default value of label
     print-empty-chapters: false
+    chapters-to-pr-without-issue: true
 ```
 
 ### Configure the Action
@@ -46,6 +47,7 @@ Configure the action by customizing the following parameters based on your needs
 - **published-at** (optional): Set to true to enable the use of the `published-at` timestamp as the reference point for searching closed issues and PRs, instead of the `created-at` date of the latest release.
 - **skip-release-notes** (optional): Set to a label name to skip issues and PRs with this label from release notes process generation. Defaults to `skip-release-notes` if not specified.
 - **print-empty-chapters** (optional): Set to true to print chapters with no issues or PRs. Defaults to false if not specified.
+- **chapters-to-pr-without-issue** (optional): Set false to avoid application of custom chapters for PRs without linked issues. Defaults to true if not specified.
 
 ## Setup
 ### Build the Action:
diff --git a/__tests__/data/rls_notes_empty_with_all_chapters.md b/__tests__/data/rls_notes_empty_with_all_chapters.md
@@ -16,13 +16,13 @@ All closed issues contain at least one of user defined labels.
 ### Closed Issues without Release Notes ⚠️
 All closed issues have release notes.
 
-### Merged PRs without Linked Issue ⚠️
+### Merged PRs without Linked Issue and Custom Labels ⚠️
 All merged PRs are linked to issues.
 
 ### Merged PRs Linked to Open Issue ⚠️
 All merged PRs are linked to Closed issues.
 
-### Closed PRs without Linked Issue ⚠️
+### Closed PRs without Linked Issue and Custom Labels ⚠️
 All closed PRs are linked to issues.
 
 #### Full Changelog
diff --git a/__tests__/data/rls_notes_empty_with_no_custom_chapters.md b/__tests__/data/rls_notes_empty_with_no_custom_chapters.md
@@ -7,13 +7,13 @@ All closed issues contain at least one of user defined labels.
 ### Closed Issues without Release Notes ⚠️
 All closed issues have release notes.
 
-### Merged PRs without Linked Issue ⚠️
+### Merged PRs without Linked Issue and Custom Labels ⚠️
 All merged PRs are linked to issues.
 
 ### Merged PRs Linked to Open Issue ⚠️
 All merged PRs are linked to Closed issues.
 
-### Closed PRs without Linked Issue ⚠️
+### Closed PRs without Linked Issue and Custom Labels ⚠️
 All closed PRs are linked to issues.
 
 #### Full Changelog
diff --git a/__tests__/data/rls_notes_fully_populated_custom_skip_label.md b/__tests__/data/rls_notes_fully_populated_custom_skip_label.md
@@ -12,10 +12,13 @@
   - note about change in Issue 4
 - #2 _Issue title 2_ implemented by @johnDoe in [#2](link-to-pr-2)
   - note about change in Issue 2
+- #1 _Issue title 1_ implemented by @janeDoe in [#1](link-to-pr-1)
+  - note about change in Issue 1
+  - note about change in Issue 1 (no bullet point at start of line)
 
 
 ### Bugfixes 🛠
-- #1 _Issue title 1_ implemented by @janeDoe in [#1](link-to-pr-1)
+- **<span style="color: red;">[Duplicate]<span>** #1 _Issue title 1_ implemented by @janeDoe in [#1](link-to-pr-1)
   - note about change in Issue 1
   - note about change in Issue 1 (no bullet point at start of line)
 
@@ -38,17 +41,17 @@
 - #3 _Issue title 3 - no release note comment|typo label_ implemented by @janeDoe in [#3](link-to-pr-3)
 
 
-### Merged PRs without Linked Issue ⚠️
-#1004 _Pull Request 4 - no linked issue - merged_
-#1006 _Pull Request 6 - skip label_
+### Merged PRs without Linked Issue and Custom Labels ⚠️
+- #1004 _Pull Request 4 - no linked issue - merged_ implemented by @janeDoe
+- #1006 _Pull Request 6 - skip label_ implemented by @janeDoe
 
 
 ### Merged PRs Linked to Open Issue ⚠️
-#1003 _Pull Request 3 - linked to open issue_
+- #1003 _Pull Request 3 - linked to open issue_
 
 
-### Closed PRs without Linked Issue ⚠️
-#1002 _Pull Request 2 - no linked issue - closed_
+### Closed PRs without Linked Issue and Custom Labels ⚠️
+- #1002 _Pull Request 2 - no linked issue - closed_ implemented by @janeDoe
 
 
 #### Full Changelog
diff --git a/__tests__/data/rls_notes_fully_populated_first_release.md b/__tests__/data/rls_notes_fully_populated_first_release.md
@@ -14,12 +14,21 @@
   - note about change in Issue 4
 - #2 _Issue title 2_ implemented by @johnDoe in [#2](link-to-pr-2)
   - note about change in Issue 2
+- #1 _Issue title 1_ implemented by @janeDoe in [#1](link-to-pr-1)
+  - note about change in Issue 1
+  - note about change in Issue 1 (no bullet point at start of line)
+- #1001 _Pull Request 1_ implemented by @janeDoe
+  - This is second PR comment ad RLS note
+  - This is third PR comment ad RLS note
 
 
 ### Bugfixes 🛠
-- #1 _Issue title 1_ implemented by @janeDoe in [#1](link-to-pr-1)
+- **<span style="color: red;">[Duplicate]<span>** #1 _Issue title 1_ implemented by @janeDoe in [#1](link-to-pr-1)
   - note about change in Issue 1
   - note about change in Issue 1 (no bullet point at start of line)
+- **<span style="color: red;">[Duplicate]<span>** #1001 _Pull Request 1_ implemented by @janeDoe
+  - This is second PR comment ad RLS note
+  - This is third PR comment ad RLS note
 
 
 ### Closed Issues without Pull Request ⚠️
@@ -37,17 +46,16 @@
 - #3 _Issue title 3 - no release note comment|typo label_ implemented by @janeDoe in [#3](link-to-pr-3)
 
 
-### Merged PRs without Linked Issue ⚠️
-#1001 _Pull Request 1_
-#1004 _Pull Request 4 - no linked issue - merged_
+### Merged PRs without Linked Issue and Custom Labels ⚠️
+- #1004 _Pull Request 4 - no linked issue - merged_ implemented by @janeDoe
 
 
 ### Merged PRs Linked to Open Issue ⚠️
-#1003 _Pull Request 3 - linked to open issue_
+- #1003 _Pull Request 3 - linked to open issue_
 
 
-### Closed PRs without Linked Issue ⚠️
-#1002 _Pull Request 2 - no linked issue - closed_
+### Closed PRs without Linked Issue and Custom Labels ⚠️
+- #1002 _Pull Request 2 - no linked issue - closed_ implemented by @janeDoe
 
 
 #### Full Changelog
diff --git a/__tests__/data/rls_notes_fully_populated_hide_warning_chapters.md b/__tests__/data/rls_notes_fully_populated_hide_warning_chapters.md
@@ -14,10 +14,13 @@
   - note about change in Issue 4
 - #2 _Issue title 2_ implemented by @johnDoe in [#2](link-to-pr-2)
   - note about change in Issue 2
+- #1 _Issue title 1_ implemented by @janeDoe in [#1](link-to-pr-1)
+  - note about change in Issue 1
+  - note about change in Issue 1 (no bullet point at start of line)
 
 
 ### Bugfixes 🛠
-- #1 _Issue title 1_ implemented by @janeDoe in [#1](link-to-pr-1)
+- **<span style="color: red;">[Duplicate]<span>** #1 _Issue title 1_ implemented by @janeDoe in [#1](link-to-pr-1)
   - note about change in Issue 1
   - note about change in Issue 1 (no bullet point at start of line)
 
diff --git a/__tests__/data/rls_notes_fully_populated_in_default.md b/__tests__/data/rls_notes_fully_populated_in_default.md
@@ -14,12 +14,21 @@
   - note about change in Issue 4
 - #2 _Issue title 2_ implemented by @johnDoe in [#2](link-to-pr-2)
   - note about change in Issue 2
+- #1 _Issue title 1_ implemented by @janeDoe in [#1](link-to-pr-1)
+  - note about change in Issue 1
+  - note about change in Issue 1 (no bullet point at start of line)
+- #1001 _Pull Request 1_ implemented by @janeDoe
+  - This is second PR comment ad RLS note
+  - This is third PR comment ad RLS note
 
 
 ### Bugfixes 🛠
-- #1 _Issue title 1_ implemented by @janeDoe in [#1](link-to-pr-1)
+- **<span style="color: red;">[Duplicate]<span>** #1 _Issue title 1_ implemented by @janeDoe in [#1](link-to-pr-1)
   - note about change in Issue 1
   - note about change in Issue 1 (no bullet point at start of line)
+- **<span style="color: red;">[Duplicate]<span>** #1001 _Pull Request 1_ implemented by @janeDoe
+  - This is second PR comment ad RLS note
+  - This is third PR comment ad RLS note
 
 
 ### Closed Issues without Pull Request ⚠️
@@ -37,17 +46,16 @@
 - #3 _Issue title 3 - no release note comment|typo label_ implemented by @janeDoe in [#3](link-to-pr-3)
 
 
-### Merged PRs without Linked Issue ⚠️
-#1001 _Pull Request 1_
-#1004 _Pull Request 4 - no linked issue - merged_
+### Merged PRs without Linked Issue and Custom Labels ⚠️
+- #1004 _Pull Request 4 - no linked issue - merged_ implemented by @janeDoe
 
 
 ### Merged PRs Linked to Open Issue ⚠️
-#1003 _Pull Request 3 - linked to open issue_
+- #1003 _Pull Request 3 - linked to open issue_
 
 
-### Closed PRs without Linked Issue ⚠️
-#1002 _Pull Request 2 - no linked issue - closed_
+### Closed PRs without Linked Issue and Custom Labels ⚠️
+- #1002 _Pull Request 2 - no linked issue - closed_ implemented by @janeDoe
 
 
 #### Full Changelog
diff --git a/__tests__/data/rls_notes_fully_populated_no_PRs_in_chapters.md b/__tests__/data/rls_notes_fully_populated_no_PRs_in_chapters.md
@@ -0,0 +1,59 @@
+### Breaking Changes 💥
+- #8 _Issue title 8 - with co-author|private mail_ implemented by @johnDoe, Jane Doe in [#8](link-to-pr-8)
+  - note about change in Issue 8
+- #7 _Issue title 7 - with co-author|public mail_ implemented by @janeDoe, @johnDoe in [#7](link-to-pr-7)
+  - note about change in Issue 7
+
+
+### New Features 🎉
+- #6 _Issue title 6 - not assigned|no PR_ implemented by "Missing Assignee or Contributor"
+  - note about change in Issue 6
+- #5 _Issue title 5 - not assigned|three PRs_ implemented by "Missing Assignee or Contributor" in [#5](link-to-pr-5), [#15](link-to-pr-15), [#16](link-to-pr-16)
+  - note about change in Issue 5
+- #4 _Issue title 4 - assigned|one PR_ implemented by @johnDoe in [#4](link-to-pr-4)
+  - note about change in Issue 4
+- #2 _Issue title 2_ implemented by @johnDoe in [#2](link-to-pr-2)
+  - note about change in Issue 2
+- #1 _Issue title 1_ implemented by @janeDoe in [#1](link-to-pr-1)
+  - note about change in Issue 1
+  - note about change in Issue 1 (no bullet point at start of line)
+
+
+### Bugfixes 🛠
+- **<span style="color: red;">[Duplicate]<span>** #1 _Issue title 1_ implemented by @janeDoe in [#1](link-to-pr-1)
+  - note about change in Issue 1
+  - note about change in Issue 1 (no bullet point at start of line)
+
+
+### Closed Issues without Pull Request ⚠️
+- #6 _Issue title 6 - not assigned|no PR_ implemented by "Missing Assignee or Contributor"
+  - note about change in Issue 6
+
+
+### Closed Issues without User Defined Labels ⚠️
+- #9 _Issue title 9 - no user defined label_ implemented by @janeDoe in [#9](link-to-pr-9)
+  - note about change in Issue 9
+- #3 _Issue title 3 - no release note comment|typo label_ implemented by @janeDoe in [#3](link-to-pr-3)
+
+
+### Closed Issues without Release Notes ⚠️
+- #3 _Issue title 3 - no release note comment|typo label_ implemented by @janeDoe in [#3](link-to-pr-3)
+
+
+### Merged PRs without Linked Issue and Custom Labels ⚠️
+- #1001 _Pull Request 1_ implemented by @janeDoe
+  - This is second PR comment ad RLS note
+  - This is third PR comment ad RLS note
+- #1004 _Pull Request 4 - no linked issue - merged_ implemented by @janeDoe
+
+
+### Merged PRs Linked to Open Issue ⚠️
+- #1003 _Pull Request 3 - linked to open issue_
+
+
+### Closed PRs without Linked Issue and Custom Labels ⚠️
+- #1002 _Pull Request 2 - no linked issue - closed_ implemented by @janeDoe
+
+
+#### Full Changelog
+https://github.com/owner/repo/compare/v0.1.0...v0.1.1
diff --git a/__tests__/data/rls_notes_fully_populated_no_custom_chapters.md b/__tests__/data/rls_notes_fully_populated_no_custom_chapters.md
@@ -28,17 +28,19 @@
 - #3 _Issue title 3 - no release note comment|typo label_ implemented by @janeDoe in [#3](link-to-pr-3)
 
 
-### Merged PRs without Linked Issue ⚠️
-#1001 _Pull Request 1_
-#1004 _Pull Request 4 - no linked issue - merged_
+### Merged PRs without Linked Issue and Custom Labels ⚠️
+- #1001 _Pull Request 1_ implemented by @janeDoe
+  - This is second PR comment ad RLS note
+  - This is third PR comment ad RLS note
+- #1004 _Pull Request 4 - no linked issue - merged_ implemented by @janeDoe
 
 
 ### Merged PRs Linked to Open Issue ⚠️
-#1003 _Pull Request 3 - linked to open issue_
+- #1003 _Pull Request 3 - linked to open issue_
 
 
-### Closed PRs without Linked Issue ⚠️
-#1002 _Pull Request 2 - no linked issue - closed_
+### Closed PRs without Linked Issue and Custom Labels ⚠️
+- #1002 _Pull Request 2 - no linked issue - closed_ implemented by @janeDoe
 
 
 #### Full Changelog
diff --git a/__tests__/data/rls_notes_fully_populated_second_release.md b/__tests__/data/rls_notes_fully_populated_second_release.md
@@ -16,13 +16,13 @@ All closed issues contain at least one of user defined labels.
 ### Closed Issues without Release Notes ⚠️
 All closed issues have release notes.
 
-### Merged PRs without Linked Issue ⚠️
+### Merged PRs without Linked Issue and Custom Labels ⚠️
 All merged PRs are linked to issues.
 
 ### Merged PRs Linked to Open Issue ⚠️
 All merged PRs are linked to Closed issues.
 
-### Closed PRs without Linked Issue ⚠️
+### Closed PRs without Linked Issue and Custom Labels ⚠️
 All closed PRs are linked to issues.
 
 #### Full Changelog
diff --git a/__tests__/generate-release-notes.test.js b/__tests__/generate-release-notes.test.js
@@ -247,6 +247,27 @@ describe('run', () => {
         expect(firstCallArgs[1]).toBe(expectedOutput);
     });
 
+    it('should run successfully with valid inputs - no PRs in chapter', async () => {
+        console.log('Test started: should run successfully with valid inputs - no PRs in chapter');
+
+        core.getInput.mockImplementation((name) => {
+            return coreMocks.fullAndNoChaptersForPRsInputs(name);
+        });
+        Octokit.mockImplementation(octokitMocks.mockFullPerfectData);
+
+        await run();
+
+        expect(core.setFailed).not.toHaveBeenCalled();
+
+        // Get the arguments of the first call to setOutput
+        const firstCallArgs = core.setOutput.mock.calls[0];
+        expect(firstCallArgs[0]).toBe('releaseNotes');
+
+        const filePath = path.join(__dirname, 'data', 'rls_notes_fully_populated_no_PRs_in_chapters.md');
+        let expectedOutput = fs.readFileSync(filePath, 'utf8');
+        expect(firstCallArgs[1]).toBe(expectedOutput);
+    });
+
     /*
     Happy path tests - no option related
     */
diff --git a/__tests__/mocks/core.mocks.js b/__tests__/mocks/core.mocks.js
diff --git a/__tests__/mocks/octokit.mocks.js b/__tests__/mocks/octokit.mocks.js
diff --git a/action.yml b/action.yml
diff --git a/dist/index.js b/dist/index.js
diff --git a/scripts/generate-release-notes.js b/scripts/generate-release-notes.js
