Feature/comment on pr (#95)

* add changelog enforcer

* set permissions

* test using octokit

* fix enforcer

* add a comment if changelog fails

* try finding comment

* log comments

* update or add comment

* update comment

* this should update the comment

* tag actor

* test enforcer

* add latest change via comment

* log latestChanges

* try adding changes directly

* log

* try skppig

* try without code block

* clean up linting and update changelog

* update actions

Author: jelmore1674

.github/workflows/enforcer.yml

@@ -9,7 +9,7 @@ permissions:
   # Give the default GITHUB_TOKEN write permission to commit and push the
   # added or changed files to the repository.
   contents: write
-  pull-requests: read
+  pull-requests: write
 
 jobs:
   enforce-changelog:
@@ -26,3 +26,5 @@ jobs:
           enable_dependabot: true
           dependabot_labels: dependencies
           dependabot_section: changed
+          comment_on_pr: true
+          show_full_name: true

README.md

@@ -455,4 +455,22 @@ dependabot_section:
   description: The section to put the dependabot changes in. Can be either `security` or `changed`.
   default: "security"
   required: false
+
+comment_on_pr:
+  description: |
+    The bot will leave a comment with a preview of the changes, if the enforce action fails it
+    will tag the user and let them know the action failed
+  default: "false"
+  required: false
+
+show_author_full_name:
+  description: Show the authors name instead of the authors username.
+  default: "false"
+  required: false
+
+name_override:
+  description: |
+    If you have a naming that you want to use that is not the github username, then you can
+    override the github username. Must use a `key=value` pair comma separated.
+  required: false
 ```

changelog/pr-comments.yml

@@ -0,0 +1,5 @@
+added:
+  - message: "Support to add pr comments to preview changes. To enable set `comment_on_pr: true`."
+    references:
+      - type: issue
+        number: 96

enforcer/action.yml

@@ -21,6 +21,24 @@ inputs:
     default: "security"
     required: false
 
+  show_author_full_name:
+    description: Show the authors name instead of the authors username.
+    default: "false"
+    required: false
+
+  name_override:
+    description: |
+      If you have a naming that you want to use that is not the github username, then you can
+      override the github username. Must use a `key=value` pair comma separated.
+    required: false
+
+  comment_on_pr:
+    description: |
+      The bot will leave a comment with a preview of the changes, if the enforce action fails it
+      will tag the user and let them know the action failed
+    default: "false"
+    required: false
+
   token:
     description: "The secret value from your GITHUB_TOKEN or another token to access the GitHub API. Defaults to the token at `github.token`"
     required: true

enforcer/index.js

@@ -1,9 +1,27 @@
-import { debug, getBooleanInput, getInput, setFailed } from "@actions/core";
-import { getExecOutput } from "@actions/exec";
+import { debug, getBooleanInput, getInput } from "@actions/core";
 import { context } from "@actions/github";
 import { exit } from "node:process";
-import { generateCommand } from "../lib/generate";
+import { type Config, config as baseConfig } from "../lib/config";
 import { addChangelogDependabot } from "./utils/addChangelogDependabot";
+import { compareChangelogs } from "./utils/compareChangelogs";
+
+/**
+ * @todo Replace with new getKeyValuePairInput inside of github-action-helpers
+ *
+ * Format a key value pair to an object.
+ *
+ * @param pair the key value pair to turn into an object.
+ */
+function formatKeyValuePairToObject(pair: string) {
+  if (!pair) {
+    return undefined;
+  }
+
+  return pair.split(",").reduce((acc, value) => {
+    acc[value.split("=")[0]] = value.split("=")[1];
+    return acc;
+  }, {} as Record<string, string>);
+}
 
 /**
  * Run the generate command and check the git diff to see if there are changes
@@ -13,9 +31,16 @@ async function enforceChangelogAction() {
   const enableDependabot = getBooleanInput("enable_dependabot", { required: false });
   const dependabotLabels = getInput("dependabot_labels").split(",") || [];
   const skipLabels = getInput("skip_labels").split(",");
+  const nameOverrideInput = getInput("name_override", { required: false });
   const pullRequest = context.payload.pull_request;
   const pullRequestLabels = pullRequest?.labels?.map((label: { name: string }) => label.name) || [];
   const set = new Set(pullRequestLabels);
+  // biome-ignore lint/style/useNamingConvention: Following yaml/toml convention.
+  const show_author_full_name = getBooleanInput("show_author_full_name", { required: false });
+  const token = getInput("token");
+  const customBotName = getInput("custom_bot_name", { required: false });
+  const nameOverrides = formatKeyValuePairToObject(nameOverrideInput);
+  const commentOnPr = getBooleanInput("comment_on_pr", { required: false });
 
   if (
     enableDependabot && dependabotLabels.some(label => set.has(label))
@@ -28,13 +53,12 @@ async function enforceChangelogAction() {
     debug("Skip Enforcing Changelog.");
     exit(0);
   }
+  const config: Omit<Config, "repo_url" | "release_url" | "changelog_archive" | "prefers"> = {
+    ...baseConfig,
+    show_author_full_name,
+  };
 
-  generateCommand("BCL_Bot", context.sha, context.payload.pull_request?.number);
-  const { stdout } = await getExecOutput("git", ["status", "--porcelain"]);
-
-  if (!stdout.match(/CHANGELOG\.md/gi)) {
-    setFailed("Changelog changes not found.");
-  }
+  await compareChangelogs(commentOnPr, token, config, nameOverrides, customBotName);
 }
 
 export { enforceChangelogAction };

generate/index.js

@@ -0,0 +1,98 @@
+import { getInput, setFailed } from "@actions/core";
+import { context, getOctokit } from "@actions/github";
+import { parseChangelog } from "@jelmore1674/changelog";
+import { readFileSync } from "node:fs";
+import { exit } from "node:process";
+import type { Config } from "../../lib/config";
+import { generateCommand } from "../../lib/generate";
+import { getChangeCount } from "../../utils/getChangeCount";
+import { getAuthorName } from "./getAuthorName";
+import { getPrNumber } from "./getPrNumber";
+
+const token = getInput("token", { required: false });
+
+async function botCommentOnPr(message: string, prNumber: number, commentId?: number) {
+  if (commentId) {
+    await getOctokit(token).rest.issues.updateComment({
+      ...context.repo,
+      // biome-ignore lint/style/useNamingConvention: Following yaml/toml convention.
+      comment_id: commentId,
+      body: message,
+    });
+
+    return;
+  }
+
+  await getOctokit(token).rest.issues.createComment({
+    // biome-ignore lint/style/useNamingConvention: Following yaml/toml convention.
+    issue_number: prNumber,
+    owner: context.repo.owner,
+    repo: context.repo.repo,
+    body: message,
+  });
+}
+
+async function compareChangelogs(
+  commentOnPr: boolean,
+  token: string,
+  config: Omit<Config, "repo_url" | "release_url" | "changelog_archive" | "prefers">,
+  nameOverrides?: Record<string, string>,
+  customBotName?: string,
+) {
+  const author = await getAuthorName(nameOverrides);
+  const prNumber = await getPrNumber();
+
+  const changelog = readFileSync("CHANGELOG.md", "utf8");
+  const existingChangelog = getChangeCount(parseChangelog(changelog).versions);
+
+  const currentChanges = generateCommand(
+    author,
+    context.sha,
+    prNumber,
+    undefined,
+    undefined,
+    config,
+    true,
+  );
+
+  const newChangelog = generateCommand(author, context.sha, prNumber);
+
+  if (commentOnPr) {
+    const botNames = ["github-actions[bot]", "build-changelog[bot]"];
+
+    if (customBotName) {
+      botNames.push(customBotName);
+    }
+
+    let exitsingCommentId: number | undefined;
+
+    const { data } = await getOctokit(token).rest.issues.listComments({
+      // biome-ignore lint/style/useNamingConvention: Following yaml/toml convention.
+      issue_number: prNumber,
+      owner: context.repo.owner,
+      repo: context.repo.repo,
+    });
+
+    const foundComment = data.find(i => i?.user?.type === "Bot" && botNames.includes(i.user.login));
+    if (foundComment) {
+      exitsingCommentId = foundComment.id;
+    }
+
+    if (existingChangelog === newChangelog.count) {
+      const failedCommentMessage = `@${context.actor} Don't forget to update your changelog.`;
+      await botCommentOnPr(failedCommentMessage, prNumber, exitsingCommentId);
+      setFailed("Changelog changes not found.");
+      exit(1);
+    }
+
+    await botCommentOnPr(currentChanges.latestChanges, prNumber, exitsingCommentId);
+
+    exit(0);
+  }
+
+  if (existingChangelog === newChangelog.count) {
+    setFailed("Changelog changes not found.");
+  }
+}
+
+export { compareChangelogs };

src/actions/enforcer.ts

@@ -18,7 +18,9 @@ program
   .command("generate")
   .description("generate the changelog")
   .option("--require-changelog", "require that changes have been made to the changelog.")
-  .action(() => generateCommand("bcl-bot", sha, 1));
+  .action(() => {
+    generateCommand("bcl-bot", sha, 1, undefined, undefined, undefined, true);
+  });
 
 program
   .command("notes [version]")

src/actions/utils/compareChangelogs.ts

@@ -1,5 +1,6 @@
 import { debug } from "@actions/core";
 import {
+  getReleaseNotes,
   type KeepAChangelogKeywords,
   parseChangelog,
   type Reference as ReferenceLink,
@@ -10,6 +11,7 @@ import { existsSync, readdirSync, readFileSync, writeFileSync } from "node:fs";
 import path from "node:path";
 import { ParsedChanges, Reference } from "../types";
 import { cleanUpChangelog } from "../utils/cleanUpChangelog";
+import { getChangeCount } from "../utils/getChangeCount";
 import { getParser } from "../utils/getParser";
 import { isTomlOrYamlFile } from "../utils/isTomlOrYamlFile";
 import { log } from "../utils/log";
@@ -226,6 +228,7 @@ function generateCommand(
   releaseVersion?: string,
   changelogOptions?: ChangelogOptions,
   actionConfig = config as Omit<Config, "repo_url" | "release_url" | "prefers">,
+  skip_changelog = false,
 ) {
   log("generate command parameters", { author, prNumber, releaseVersion, changelogOptions });
 
@@ -236,7 +239,7 @@ function generateCommand(
   let changelogVersions: Version<Partial<Record<KeepAChangelogKeywords, string[]>>>[] = [];
   let changelogLinks: ReferenceLink[] = [];
 
-  if (existsSync(changelogPath)) {
+  if (!skip_changelog && existsSync(changelogPath)) {
     const changelogFile = readFileSync(changelogPath, { encoding: "utf8" });
     const changelog = parseChangelog(changelogFile, releaseVersion);
     changelogVersions = changelog.versions;
@@ -430,15 +433,25 @@ function generateCommand(
     changelogOptions,
   );
 
+  const latestChanges = getReleaseNotes(renderedChangelog).replace("# What's Changed\n\n", "");
+
   debug(renderedChangelog);
 
-  writeFileSync(changelogPath, renderedChangelog, { encoding: "utf8" });
+  if (!skip_changelog) {
+    writeFileSync(changelogPath, renderedChangelog, { encoding: "utf8" });
+
+    cleanUpChangelog(actionConfig.dir);
+  }
 
   log("CHANGELOG.md finished writing.");
 
-  cleanUpChangelog(actionConfig.dir);
+  const count = getChangeCount(sortedVersions);
 
   rl.close();
+  return {
+    count,
+    latestChanges,
+  };
 }
 
 export { generateCommand, parseChanges };