- introduce proper configuration for fetchReviews

- drop no longer needed limiting of PRs
- retrieve state from PR review comment

README.md

@@ -523,6 +523,7 @@ it('Test custom changelog builder', async () => {
     false, // ignorePrePrelease
     true,  // enable to fetch reviewers
     false, // enable to fetch release information
+    false, // enable to fetch reviews
     false, // commitMode
     configuration  // configuration
   )

__tests__/releaseNotes.test.ts

@@ -20,6 +20,7 @@ it('Should have empty changelog (tags)', async () => {
     failOnError: false,
     fetchReviewers: false,
     fetchReleaseInformation: false,
+    fetchReviews: false,
     commitMode: false,
     configuration
   })
@@ -40,6 +41,7 @@ it('Should match generated changelog (tags)', async () => {
     failOnError: false,
     fetchReviewers: false,
     fetchReleaseInformation: false,
+    fetchReviews: false,
     commitMode: false,
     configuration
   })
@@ -65,6 +67,7 @@ it('Should match generated changelog (refs)', async () => {
     failOnError: false,
     fetchReviewers: false,
     fetchReleaseInformation: false,
+    fetchReviews: false,
     commitMode: false,
     configuration
   })
@@ -98,6 +101,7 @@ it('Should match generated changelog and replace all occurrences (refs)', async
     failOnError: false,
     fetchReviewers: false,
     fetchReleaseInformation: false,
+    fetchReviews: false,
     commitMode: false,
     configuration
   })
@@ -133,6 +137,7 @@ it('Should match ordered ASC', async () => {
     failOnError: false,
     fetchReviewers: false,
     fetchReleaseInformation: false,
+    fetchReviews: false,
     commitMode: false,
     configuration
   })
@@ -153,6 +158,7 @@ it('Should match ordered DESC', async () => {
     failOnError: false,
     fetchReviewers: false,
     fetchReleaseInformation: false,
+    fetchReviews: false,
     commitMode: false,
     configuration
   })
@@ -173,6 +179,7 @@ it('Should match ordered by title ASC', async () => {
     failOnError: false,
     fetchReviewers: false,
     fetchReleaseInformation: false,
+    fetchReviews: false,
     commitMode: false,
     configuration
   })
@@ -195,6 +202,7 @@ it('Should match ordered by title DESC', async () => {
     failOnError: false,
     fetchReviewers: false,
     fetchReleaseInformation: false,
+    fetchReviews: false,
     commitMode: false,
     configuration
   })
@@ -217,6 +225,7 @@ it('Should ignore PRs not merged into develop branch', async () => {
     failOnError: false,
     fetchReviewers: false,
     fetchReleaseInformation: false,
+    fetchReviews: false,
     commitMode: false,
     configuration
   })
@@ -237,6 +246,7 @@ it('Should ignore PRs not merged into main branch', async () => {
     failOnError: false,
     fetchReviewers: false,
     fetchReleaseInformation: false,
+    fetchReviews: false,
     commitMode: false,
     configuration
   })

__tests__/releaseNotesBuilder.test.ts

@@ -18,6 +18,7 @@ it('Should match generated changelog (unspecified fromTag)', async () => {
     false,
     false, // enable to fetch reviewers
     false, // enable to fetch tag release information
+    false, // enable to fetch reviews
     false,
     configuration
   )
@@ -47,6 +48,7 @@ it('Should match generated changelog (unspecified tags)', async () => {
     false,
     false, // enable to fetch reviewers
     false, // enable to fetch tag release information
+    false, // enable to fetch reviews
     false,
     configuration
   )
@@ -71,6 +73,7 @@ it('Should use empty placeholder', async () => {
     false,
     false, // enable to fetch reviewers
     false, // enable to fetch tag release information
+    false, // enable to fetch reviews
     false,
     configuration
   )
@@ -95,6 +98,7 @@ it('Should fill empty placeholders', async () => {
     false,
     false, // enable to fetch reviewers
     false, // enable to fetch tag release information
+    false, // enable to fetch reviews
     false,
     configuration
   )
@@ -121,6 +125,7 @@ it('Should fill `template` placeholders', async () => {
     false,
     false, // enable to fetch reviewers
     false, // enable to fetch tag release information
+    false, // enable to fetch reviews
     false,
     configuration
   )
@@ -147,6 +152,7 @@ it('Should fill `template` placeholders, ignore', async () => {
     false,
     false, // enable to fetch reviewers
     false, // enable to fetch tag release information
+    false, // enable to fetch reviews
     false,
     configuration
   )
@@ -173,6 +179,7 @@ it('Uncategorized category', async () => {
     false,
     false, // enable to fetch reviewers
     false, // enable to fetch tag release information
+    false, // enable to fetch reviews
     false,
     configuration
   )
@@ -199,6 +206,7 @@ it('Verify commit based changelog', async () => {
     false,
     false, // enable to fetch reviewers
     false, // enable to fetch tag release information
+    false, // enable to fetch reviews
     true,
     configuration
   )
@@ -225,6 +233,7 @@ it('Verify commit based changelog, with emoji categorisation', async () => {
     false,
     false, // enable to fetch reviewers
     false, // enable to fetch tag release information
+    false, // enable to fetch reviews
     true,
     configuration
   )
@@ -251,6 +260,7 @@ it('Verify default inclusion of open PRs', async () => {
     false, // ignorePrePrelease
     false, // enable to fetch reviewers
     false, // enable to fetch tag release information
+    false, // enable to fetch reviews
     false, // commitMode
     configuration // configuration
   )
@@ -277,6 +287,7 @@ it('Verify custom categorisation of open PRs', async () => {
     false, // ignorePrePrelease
     false, // enable to fetch reviewers
     false, // enable to fetch tag release information
+    false, // enable to fetch reviews
     false, // commitMode
     configuration // configuration
   )
@@ -303,6 +314,7 @@ it('Verify reviewers who approved are fetched and also release information', asy
     false, // ignorePrePrelease
     true, // enable to fetch reviewers
     true, // enable to fetch tag release information
+    false, // enable to fetch reviews
     false, // commitMode
     configuration // configuration
   )
@@ -330,6 +342,7 @@ it('Fetch release information', async () => {
     false, // ignorePrePrelease
     false, // enable to fetch reviewers
     true, // enable to fetch tag release information
+    false, // enable to fetch reviews
     false, // commitMode
     configuration // configuration
   )
@@ -355,6 +368,7 @@ it('Fetch release information for non existing tag / release', async () => {
     false, // ignorePrePrelease
     false, // enable to fetch reviewers
     true, // enable to fetch tag release information
+    false, // enable to fetch reviews
     false, // commitMode
     configuration // configuration
   )

__tests__/transform.test.ts

@@ -140,6 +140,7 @@ it('Extract label from title, combined regex', async () => {
     failOnError: false,
     fetchReviewers: false,
     fetchReleaseInformation: false,
+    fetchReviews: false,
     commitMode: false,
     configuration
   })
@@ -169,6 +170,7 @@ it('Extract label from title and body, combined regex', async () => {
     failOnError: false,
     fetchReviewers: false,
     fetchReleaseInformation: false,
+    fetchReviews: false,
     commitMode: false,
     configuration
   })
@@ -201,6 +203,7 @@ it('Extract label from title, split regex', async () => {
     failOnError: false,
     fetchReviewers: false,
     fetchReleaseInformation: false,
+    fetchReviews: false,
     commitMode: false,
     configuration
   })
@@ -233,6 +236,7 @@ it('Extract label from title, match', async () => {
     failOnError: false,
     fetchReviewers: false,
     fetchReleaseInformation: false,
+    fetchReviews: false,
     commitMode: false,
     configuration
   })
@@ -260,6 +264,7 @@ it('Extract label from title, match multiple', async () => {
     failOnError: false,
     fetchReviewers: false,
     fetchReleaseInformation: false,
+    fetchReviews: false,
     commitMode: false,
     configuration
   })
@@ -288,6 +293,7 @@ it('Extract label from title, match multiple, custon non matching label', async
     failOnError: false,
     fetchReviewers: false,
     fetchReleaseInformation: false,
+    fetchReviews: false,
     commitMode: false,
     configuration
   })
@@ -403,6 +409,7 @@ it('Match multiple labels exhaustive for category', async () => {
     failOnError: false,
     fetchReviewers: false,
     fetchReleaseInformation: false,
+    fetchReviews: false,
     commitMode: false,
     configuration: customConfig
   })
@@ -429,6 +436,7 @@ it('Deduplicate duplicated PRs', async () => {
     failOnError: false,
     fetchReviewers: false,
     fetchReleaseInformation: false,
+    fetchReviews: false,
     commitMode: false,
     configuration: customConfig
   })
@@ -456,6 +464,7 @@ it('Deduplicate duplicated PRs DESC', async () => {
     failOnError: false,
     fetchReviewers: false,
     fetchReleaseInformation: false,
+    fetchReviews: false,
     commitMode: false,
     configuration: customConfig
   })
@@ -488,6 +497,7 @@ it('Use empty_content for empty category', async () => {
     failOnError: false,
     fetchReviewers: false,
     fetchReleaseInformation: false,
+    fetchReviews: false,
     commitMode: false,
     configuration: customConfig
   })
@@ -511,6 +521,7 @@ it('Commit SHA-1 in commitMode', async () => {
     failOnError: false,
     fetchReviewers: false,
     fetchReleaseInformation: false,
+    fetchReviews: false,
     commitMode: true,
     configuration: customConfig
   })
@@ -531,6 +542,7 @@ it('Release Diff', async () => {
     failOnError: false,
     fetchReviewers: false,
     fetchReleaseInformation: true,
+    fetchReviews: false,
     commitMode: true,
     configuration: customConfig
   })
@@ -570,6 +582,7 @@ it('Use exclude labels to not include a PR within a category.', async () => {
     failOnError: false,
     fetchReviewers: false,
     fetchReleaseInformation: false,
+    fetchReviews: false,
     commitMode: false,
     configuration: customConfig
   })
@@ -628,6 +641,7 @@ it('Extract custom placeholder from PR body and replace in global template', asy
     failOnError: false,
     fetchReviewers: false,
     fetchReleaseInformation: false,
+    fetchReviews: false,
     commitMode: false,
     configuration: customConfig
   })

action.yml

@@ -34,6 +34,9 @@ inputs:
   fetchReleaseInformation:
     description: 'Will enable fetching release information for the tags. E.g. creation date'
     default: "false"
+  fetchReviews:
+    description: 'Will enable fetching the reviews (comments) attached to the PR'
+    default: "false"
   commitMode:
     description: 'Enables a `light` commit based mode. This mode generates changelogs based on the commits. Please note that this is not officially supported, and lacks a lot of features only possible with PRs.'
     default: "false"

dist/index.js

@@ -420,8 +420,9 @@ function run() {
             const failOnError = core.getInput('failOnError') === 'true';
             const fetchReviewers = core.getInput('fetchReviewers') === 'true';
             const fetchReleaseInformation = core.getInput('fetchReleaseInformation') === 'true';
+            const fetchReviews = core.getInput('fetchReviews') === 'true';
             const commitMode = core.getInput('commitMode') === 'true';
-            const result = yield new releaseNotesBuilder_1.ReleaseNotesBuilder(baseUrl, token, repositoryPath, owner, repo, fromTag, toTag, includeOpen, failOnError, ignorePreReleases, fetchReviewers, fetchReleaseInformation, commitMode, configuration).build();
+            const result = yield new releaseNotesBuilder_1.ReleaseNotesBuilder(baseUrl, token, repositoryPath, owner, repo, fromTag, toTag, includeOpen, failOnError, ignorePreReleases, fetchReviewers, fetchReleaseInformation, fetchReviews, commitMode, configuration).build();
             core.setOutput('changelog', result);
             // write the result in changelog to file if possible
             const outputFile = core.getInput('outputFile');
@@ -488,9 +489,17 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", ({ value: true }));
-exports.compare = exports.sortPullRequests = exports.PullRequests = void 0;
+exports.compare = exports.sortPullRequests = exports.PullRequests = exports.EMPTY_COMMENT_INFO = void 0;
 const core = __importStar(__nccwpck_require__(2186));
 const moment_1 = __importDefault(__nccwpck_require__(9623));
+exports.EMPTY_COMMENT_INFO = {
+    id: 0,
+    htmlURL: '',
+    submittedAt: undefined,
+    author: '',
+    body: '',
+    state: undefined
+};
 class PullRequests {
     constructor(octokit) {
         this.octokit = octokit;
@@ -762,7 +771,8 @@ const mapComment = (comment) => {
         htmlURL: comment.html_url,
         submittedAt: comment.submitted_at ? (0, moment_1.default)(comment.submitted_at) : undefined,
         author: ((_a = comment.user) === null || _a === void 0 ? void 0 : _a.login) || '',
-        body: comment.body
+        body: comment.body,
+        state: comment.state
     });
 };
 
@@ -882,8 +892,7 @@ class ReleaseNotes {
     getMergedPullRequests(octokit) {
         var _a, _b;
         return __awaiter(this, void 0, void 0, function* () {
-            const { owner, repo, includeOpen, fetchReviewers, configuration } = this.options;
-            const fetchReviews = true; // TEMPORARY!!
+            const { owner, repo, includeOpen, fetchReviewers, fetchReviews, configuration } = this.options;
             const diffInfo = yield this.getCommitHistory(octokit);
             const commits = diffInfo.commitInfo;
             if (commits.length === 0) {
@@ -1055,7 +1064,7 @@ const tags_1 = __nccwpck_require__(7532);
 const utils_1 = __nccwpck_require__(918);
 const https_proxy_agent_1 = __nccwpck_require__(7219);
 class ReleaseNotesBuilder {
-    constructor(baseUrl, token, repositoryPath, owner, repo, fromTag, toTag, includeOpen = false, failOnError, ignorePreReleases, fetchReviewers = false, fetchReleaseInformation = false, commitMode, configuration) {
+    constructor(baseUrl, token, repositoryPath, owner, repo, fromTag, toTag, includeOpen = false, failOnError, ignorePreReleases, fetchReviewers = false, fetchReleaseInformation = false, fetchReviews = false, commitMode, configuration) {
         this.baseUrl = baseUrl;
         this.token = token;
         this.repositoryPath = repositoryPath;
@@ -1068,6 +1077,7 @@ class ReleaseNotesBuilder {
         this.ignorePreReleases = ignorePreReleases;
         this.fetchReviewers = fetchReviewers;
         this.fetchReleaseInformation = fetchReleaseInformation;
+        this.fetchReviews = fetchReviews;
         this.commitMode = commitMode;
         this.configuration = configuration;
     }
@@ -1150,6 +1160,7 @@ class ReleaseNotesBuilder {
                 failOnError: this.failOnError,
                 fetchReviewers: this.fetchReviewers,
                 fetchReleaseInformation: this.fetchReleaseInformation,
+                fetchReviews: this.fetchReviews,
                 commitMode: this.commitMode,
                 configuration: this.configuration
             };
@@ -1593,12 +1604,6 @@ function buildChangelog(diffInfo, prs, options) {
             core.warning(`⚠️ Configured \`duplicate_filter\` invalid.`);
         }
     }
-    // limit the PRs to the `max_pull_requests`
-    const max_pull_requests = config.max_pull_requests || configuration_1.DefaultConfiguration.max_pull_requests;
-    if (prs.length > max_pull_requests) {
-        core.info(`ℹ️ Retrieved ${prs.length} PRs, limit count to: ${max_pull_requests} (max_pull_requests).`);
-        prs.length = Math.min(prs.length, max_pull_requests);
-    }
     // extract additional labels from the commit message
     const labelExtractors = validateTransformers(config.label_extractor);
     for (const extractor of labelExtractors) {
@@ -1875,14 +1880,7 @@ function replaceReviewPlaceholders(template, parentKey, values) {
     var _a;
     let transformed = template;
     // retrieve the keys from the CommentInfo object
-    const comment = {
-        id: 0,
-        htmlURL: '',
-        submittedAt: undefined,
-        author: '',
-        body: ''
-    };
-    for (const childKey of Object.keys(comment)) {
+    for (const childKey of Object.keys(pullRequests_1.EMPTY_COMMENT_INFO)) {
         for (let i = 0; i < values.length; i++) {
             transformed = transformed.replaceAll(`\${{${parentKey}[${i}].${childKey}}}`, ((_a = values[i][childKey]) === null || _a === void 0 ? void 0 : _a.toLocaleString('en')) || '');
         }

src/main.ts

@@ -40,6 +40,7 @@ async function run(): Promise<void> {
     const failOnError = core.getInput('failOnError') === 'true'
     const fetchReviewers = core.getInput('fetchReviewers') === 'true'
     const fetchReleaseInformation = core.getInput('fetchReleaseInformation') === 'true'
+    const fetchReviews = core.getInput('fetchReviews') === 'true'
     const commitMode = core.getInput('commitMode') === 'true'
 
     const result = await new ReleaseNotesBuilder(
@@ -55,6 +56,7 @@ async function run(): Promise<void> {
       ignorePreReleases,
       fetchReviewers,
       fetchReleaseInformation,
+      fetchReviews,
       commitMode,
       configuration
     ).build()

src/pullRequests.ts

@@ -31,6 +31,16 @@ export interface CommentInfo {
   submittedAt: moment.Moment | undefined
   author: string
   body: string
+  state: string | undefined
+}
+
+export const EMPTY_COMMENT_INFO: CommentInfo = {
+  id: 0,
+  htmlURL: '',
+  submittedAt: undefined,
+  author: '',
+  body: '',
+  state: undefined
 }
 
 type PullData = RestEndpointMethodTypes['pulls']['get']['response']['data']
@@ -251,5 +261,6 @@ const mapComment = (comment: Unpacked<PullReviewsData>): CommentInfo => ({
   htmlURL: comment.html_url,
   submittedAt: comment.submitted_at ? moment(comment.submitted_at) : undefined,
   author: comment.user?.login || '',
-  body: comment.body
+  body: comment.body,
+  state: comment.state
 })

src/releaseNotes.ts

@@ -16,6 +16,7 @@ export interface ReleaseNotesOptions {
   failOnError: boolean // defines if we should fail the action in case of an error
   fetchReviewers: boolean // defines if the action should fetch the reviewers for PRs - approved reviewers are not included in the default PR listing
   fetchReleaseInformation: boolean // defines if the action should fetch the release information for the from and to tag - e.g. the creation date for the associated release
+  fetchReviews: boolean // defines if the action should fetch the reviews for the PR.
   commitMode: boolean // defines if we use the alternative commit based mode. note: this is only partially supported
   configuration: Configuration // the configuration as defined in `configuration.ts`
 }
@@ -94,8 +95,7 @@ export class ReleaseNotes {
   }
 
   private async getMergedPullRequests(octokit: Octokit): Promise<[DiffInfo, PullRequestInfo[]]> {
-    const {owner, repo, includeOpen, fetchReviewers, configuration} = this.options
-    const fetchReviews = true // TEMPORARY!!
+    const {owner, repo, includeOpen, fetchReviewers, fetchReviews, configuration} = this.options
 
     const diffInfo = await this.getCommitHistory(octokit)
     const commits = diffInfo.commitInfo

src/releaseNotesBuilder.ts

@@ -20,6 +20,7 @@ export class ReleaseNotesBuilder {
     private ignorePreReleases: boolean,
     private fetchReviewers: boolean = false,
     private fetchReleaseInformation: boolean = false,
+    private fetchReviews: boolean = false,
     private commitMode: boolean,
     private configuration: Configuration
   ) {}
@@ -117,6 +118,7 @@ export class ReleaseNotesBuilder {
       failOnError: this.failOnError,
       fetchReviewers: this.fetchReviewers,
       fetchReleaseInformation: this.fetchReleaseInformation,
+      fetchReviews: this.fetchReviews,
       commitMode: this.commitMode,
       configuration: this.configuration
     }

src/transform.ts

@@ -1,6 +1,6 @@
 import * as core from '@actions/core'
 import {Category, DefaultConfiguration, Extractor, Placeholder, Transformer} from './configuration'
-import {CommentInfo, PullRequestInfo, sortPullRequests} from './pullRequests'
+import {CommentInfo, EMPTY_COMMENT_INFO, PullRequestInfo, sortPullRequests} from './pullRequests'
 import {ReleaseNotesOptions} from './releaseNotes'
 import {DiffInfo} from './commits'
 import {createOrSet, haveCommonElements, haveEveryElements} from './utils'
@@ -47,13 +47,6 @@ export function buildChangelog(diffInfo: DiffInfo, prs: PullRequestInfo[], optio
     }
   }
 
-  // limit the PRs to the `max_pull_requests`
-  const max_pull_requests = config.max_pull_requests || DefaultConfiguration.max_pull_requests
-  if (prs.length > max_pull_requests) {
-    core.info(`ℹ️ Retrieved ${prs.length} PRs, limit count to: ${max_pull_requests} (max_pull_requests).`)
-    prs.length = Math.min(prs.length, max_pull_requests)
-  }
-
   // extract additional labels from the commit message
   const labelExtractors = validateTransformers(config.label_extractor)
   for (const extractor of labelExtractors) {
@@ -400,14 +393,7 @@ function replaceReviewPlaceholders(template: string, parentKey: string, values:
   let transformed = template
 
   // retrieve the keys from the CommentInfo object
-  const comment: CommentInfo = {
-    id: 0,
-    htmlURL: '',
-    submittedAt: undefined,
-    author: '',
-    body: ''
-  }
-  for (const childKey of Object.keys(comment)) {
+  for (const childKey of Object.keys(EMPTY_COMMENT_INFO)) {
     for (let i = 0; i < values.length; i++) {
       transformed = transformed.replaceAll(
         `\${{${parentKey}[${i}].${childKey}}}`,