feat: automatic closing of the issue when released

* add automatic closing feature for issues that are no longer needed
* improved code coverage with additional testing
* fix #23

Author: gilach

README.md

@@ -1,5 +1,7 @@
 # github-action-notify-release
 
+GitHub Action that automatically creates an issue with an overview of the commits that are waiting to be released. After creating the release, the issue will be automatically closed during next action run.
+
 ## Usage
 Configure this action in your workflows providing the inputs described below in order to get notified in `x` days after the repo has been updated but no npm release has happened.
 
@@ -9,6 +11,9 @@ Configure this action in your workflows providing the inputs described below in
 ### `stale-days: 7`
 _Optional_ The number of days after which unreleased commits should be considered stale and should notify for a release. Default is `7`.
 
+### `commit-messages-lines: 1`
+_Optional_ Limit the number of first x lines from commit messages that will be added in the issue description. No truncation when set to `0`. Default is `1`.
+
 ## Notes
 - Checks and compares npm last modified date and git latest repo update.
 - If the repo doesn't have an npm package linked the run will exit with a warning log.

dist/index.js

@@ -5889,6 +5889,115 @@ function wrappy (fn, cb) {
 }
 
 
+/***/ }),
+
+/***/ 465:
+/***/ ((module, __unused_webpack_exports, __nccwpck_require__) => {
+
+"use strict";
+
+const github = __nccwpck_require__(438);
+const { logInfo } = __nccwpck_require__(653);
+
+const ISSUE_LABEL = 'notify-release';
+const ISSUE_TITLE = 'Release pending!';
+const STATE_OPEN = 'open';
+const STATE_CLOSED = 'closed';
+
+async function createIssue(token, issueBody) {
+  const octokit = github.getOctokit(token);
+
+  return octokit.issues.create({
+    ...github.context.repo,
+    title: ISSUE_TITLE,
+    body: issueBody,
+    labels: [ISSUE_LABEL],
+  });
+}
+
+async function getLastOpenPendingIssue(token) {
+  const octokit = github.getOctokit(token);
+  const { owner, repo } = github.context.repo;
+
+  const pendingIssues = await octokit.request(`GET /repos/{owner}/{repo}/issues`, {
+    owner,
+    repo,
+    creator: 'app/github-actions',
+    state: STATE_OPEN,
+    sort: 'created',
+    direction: 'desc',
+    labels: ISSUE_LABEL
+  });
+
+  return pendingIssues.data.length ? pendingIssues.data[0] : null;
+}
+
+async function updateLastOpenPendingIssue(token, issueBody, issueNo) {
+  const octokit = github.getOctokit(token);
+  const { owner, repo } = github.context.repo;
+
+  const updatedIssue = await octokit.request(`PATCH /repos/{owner}/{repo}/issues/${issueNo}`, {
+    owner,
+    repo,
+    title: ISSUE_TITLE,
+    body: issueBody
+  });
+
+  return updatedIssue.data.length ? updatedIssue.data[0] : null;
+}
+
+async function createOrUpdateIssue(token, unreleasedCommits, pendingIssue, latestRelease, commitMessageLines) {
+  const commitStr = unreleasedCommits.map((commit) => `Commit: ${formatCommitMessage(commit.commit.message, commitMessageLines)}  
+Author: ${commit.commit.author.name}  
+
+`).join('');
+  const issueBody = `Unreleased commits have been found which are pending release, please publish the changes.
+  
+  ### Commits since the last release
+  ${commitStr}`;
+
+  if (pendingIssue) {
+    await updateLastOpenPendingIssue(token, issueBody, pendingIssue.number);
+    logInfo(`Issue ${pendingIssue.number} has been updated`);
+  } else {
+    const issueNo = await createIssue(token, issueBody);
+    logInfo(`New issue has been created. Issue No. - ${issueNo}`);
+  }
+}
+
+function formatCommitMessage(fullCommitMessage, numberOfLines) {
+  if (!numberOfLines || numberOfLines < 0) {
+    return fullCommitMessage;
+  }
+  return fullCommitMessage
+    .split('\n')
+    .slice(0, numberOfLines)
+    .join('\n')
+    .trim();
+}
+
+async function closeIssue(token, issueNo) {
+  const octokit = github.getOctokit(token);
+  const { owner, repo } = github.context.repo;
+
+  await octokit.request(`PATCH /repos/{owner}/{repo}/issues/${issueNo}`, {
+    owner,
+    repo,
+    state: STATE_CLOSED
+  });
+  logInfo(`Closed issue no. - ${issueNo}`);
+}
+
+module.exports = {
+  createIssue,
+  getLastOpenPendingIssue,
+  updateLastOpenPendingIssue,
+  formatCommitMessage,
+  createOrUpdateIssue,
+  closeIssue
+};
+
+
 /***/ }),
 
 /***/ 653:
@@ -5910,121 +6019,94 @@ exports.logWarning = log(warning);
 
 /***/ }),
 
-/***/ 26:
+/***/ 254:
 /***/ ((module, __unused_webpack_exports, __nccwpck_require__) => {
 
 "use strict";
 
-const github = __nccwpck_require__(438);
 
-async function getLatestRelease(token) {
-  const octokit = github.getOctokit(token);
-  const { owner, repo } = github.context.repo;
-
-  const allReleasesResp = await octokit.request(`GET /repos/{owner}/{repo}/releases`, {
-    owner,
-    repo,
-  });
+const { logInfo } = __nccwpck_require__(653);
+const { getLatestRelease, getUnreleasedCommits } = __nccwpck_require__(26);
+const { createOrUpdateIssue, getLastOpenPendingIssue, closeIssue } = __nccwpck_require__(465);
 
-  return allReleasesResp.data.length ? allReleasesResp.data[0] : null;
-}
+async function runAction(token, staleDays, commitMessageLines) {
+  const latestRelease = await getLatestRelease(token);
 
-async function getUnreleasedCommits(token, latestReleaseDate, staleDays) {
-  const octokit = github.getOctokit(token);
-  const { owner, repo } = github.context.repo;
+  if (!latestRelease) {
+    return logInfo('Could not find latest release');
+  }
 
-  const allCommitsResp = await octokit.request(`GET /repos/{owner}/{repo}/commits`, {
-    owner,
-    repo,
-    since: latestReleaseDate,
-  });
+  logInfo(`Latest release - name:${latestRelease.name}, created:${latestRelease.created_at},
+Tag:${latestRelease.tag_name}, author:${latestRelease.author.login}`);
 
-  const staleDate = new Date().getTime() - (staleDays * 24 * 60 * 60 * 1000);
+  let pendingIssue = await getLastOpenPendingIssue(token);
+  const unreleasedCommits = await getUnreleasedCommits(
+    token,
+    latestRelease.created_at,
+    staleDays,
+  );
 
-  for (const commit of allCommitsResp.data) {
-    const commitDate = new Date(commit.commit.committer.date).getTime();
-    if (commitDate < staleDate) {
-      return allCommitsResp.data;
+  if (unreleasedCommits.length) {
+    await createOrUpdateIssue(token, unreleasedCommits, pendingIssue, latestRelease, commitMessageLines);
+  } else {
+    logInfo('No pending commits found');
+    if (pendingIssue && Date.parse(latestRelease.created_at) > Date.parse(pendingIssue.updated_at)) {
+      await closeIssue(token, pendingIssue.number);
     }
   }
-
-  return [];
 }
 
 module.exports = {
-  getLatestRelease,
-  getUnreleasedCommits,
+  runAction,
 };
 
 
 /***/ }),
 
-/***/ 608:
+/***/ 26:
 /***/ ((module, __unused_webpack_exports, __nccwpck_require__) => {
 
 "use strict";
 
 const github = __nccwpck_require__(438);
 
-async function createIssue(token, issueTitle, issueBody, label) {
-  const octokit = github.getOctokit(token);
-
-  return octokit.issues.create({
-    ...github.context.repo,
-    title: issueTitle,
-    body: issueBody,
-    labels: [label],
-  });
-}
-
-async function getLastOpenPendingIssue(token, latestReleaseDate, label) {
+async function getLatestRelease(token) {
   const octokit = github.getOctokit(token);
   const { owner, repo } = github.context.repo;
 
-  const pendingIssues = await octokit.request(`GET /repos/{owner}/{repo}/issues`, {
+  const allReleasesResp = await octokit.request(`GET /repos/{owner}/{repo}/releases/latest`, {
     owner,
     repo,
-    since: latestReleaseDate,
-    creator: 'app/github-actions',
-    state: 'open',
-    sort: 'created',
-    direction: 'desc',
-    labels: label
   });
 
-  return pendingIssues.data.length ? pendingIssues.data[0] : null;
+  return allReleasesResp.data;
 }
 
-async function updateLastOpenPendingIssue(token, issueTitle, issueBody, issueNo) {
+async function getUnreleasedCommits(token, latestReleaseDate, staleDays) {
   const octokit = github.getOctokit(token);
   const { owner, repo } = github.context.repo;
 
-  const updatedIssue = await octokit.request(`PATCH /repos/{owner}/{repo}/issues/${issueNo}`, {
+  const allCommitsResp = await octokit.request(`GET /repos/{owner}/{repo}/commits`, {
     owner,
     repo,
-    title: issueTitle,
-    body: issueBody
+    since: latestReleaseDate,
   });
 
-  return updatedIssue.data.length ? updatedIssue.data[0] : null;
-}
+  const staleDate = new Date().getTime() - (staleDays * 24 * 60 * 60 * 1000);
 
-function formatCommitMessage(fullCommitMessage, numberOfLines) {
-  if (!numberOfLines || numberOfLines < 0) {
-    return fullCommitMessage;
+  for (const commit of allCommitsResp.data) {
+    const commitDate = new Date(commit.commit.committer.date).getTime();
+    if (commitDate < staleDate) {
+      return allCommitsResp.data;
+    }
   }
-  return fullCommitMessage
-    .split('\n')
-    .slice(0, numberOfLines)
-    .join('\n')
-    .trim();
+
+  return [];
 }
 
 module.exports = {
-  createIssue,
-  getLastOpenPendingIssue,
-  updateLastOpenPendingIssue,
-  formatCommitMessage,
+  getLatestRelease,
+  getUnreleasedCommits,
 };
 
 
@@ -6185,54 +6267,16 @@ var __webpack_exports__ = {};
 
 const core = __nccwpck_require__(186);
 const { logInfo } = __nccwpck_require__(653);
-const { getLatestRelease, getUnreleasedCommits } = __nccwpck_require__(26);
-const { createIssue, getLastOpenPendingIssue, updateLastOpenPendingIssue, formatCommitMessage } = __nccwpck_require__(608);
+
+const { runAction } = __nccwpck_require__(254);
 
 async function run() {
   try {
     const token = core.getInput('github-token', { required: true });
     const staleDays = Number(core.getInput('stale-days'));
     const commitMessageLines = Number(core.getInput('commit-messages-lines'));
-    const latestRelease = await getLatestRelease(token);
-    const label = 'notify-release';
-
-    if (!latestRelease) {
-      return logInfo('Could not find latest release');
-    }
-
-    logInfo(`Latest release - name:${latestRelease.name}, created:${latestRelease.created_at},
-Tag:${latestRelease.tag_name}, author:${latestRelease.author.login}`);
-
-    const unreleasedCommits = await getUnreleasedCommits(
-      token,
-      latestRelease.created_at,
-      staleDays,
-    );
-
-    if (unreleasedCommits.length) {
-      const commitStr = unreleasedCommits.map((commit) => `Commit: ${formatCommitMessage(commit.commit.message, commitMessageLines)}  
-Author: ${commit.commit.author.name}  
 
-`).join('');
-      const issueBody = `Unreleased commits have been found which are pending release, please publish the changes.
-  
-  ### Commits since the last release
-  ${commitStr}`;
-      const issueTitle = 'Release pending!';
-
-      const lastPendingIssue = await getLastOpenPendingIssue(token, latestRelease.created_at, label);
-
-      if (lastPendingIssue) {
-        await updateLastOpenPendingIssue(token, issueTitle, issueBody, lastPendingIssue.number);
-        logInfo(`Issue ${lastPendingIssue.number} has been updated`);
-      } else {
-        const issueNo = await createIssue(token, issueTitle, issueBody, label);
-        logInfo(`New issue has been created. Issue No. - ${JSON.stringify(issueNo.data.number)}`);
-      }
-
-    } else {
-      logInfo('No pending commits found');
-    }
+    return await runAction(token, staleDays, commitMessageLines);
   } catch (error) {
     logInfo(error.message);
     core.setFailed(error.message);