Fix tests

Author: gossi

src/changelog.ts

@@ -5,7 +5,7 @@ import progressBar from "./progress-bar";
 import { Configuration } from "./configuration";
 import findPullRequestId from "./find-pull-request-id";
 import * as Git from "./git";
-import GithubAPI, { GitHubUserResponse } from "./github-api";
+import GithubAPI, { GitHubContributor } from "./github-api";
 import { CommitInfo, Release } from "./interfaces";
 import MarkdownRenderer from "./markdown-renderer";
 
@@ -124,8 +124,8 @@ export default class Changelog {
     return Git.listCommits(from, to);
   }
 
-  private async getCommitters(commits: CommitInfo[]): Promise<GitHubUserResponse[]> {
-    const committers: { [id: string]: GitHubUserResponse } = {};
+  private async getCommitters(commits: CommitInfo[]): Promise<GitHubContributor[]> {
+    const committers: { [id: string]: GitHubContributor } = {};
 
     for (const commit of commits) {
       const issue = commit.githubIssue;

src/github-api.ts

@@ -3,15 +3,22 @@ const path = require("path");
 import ConfigurationError from "./configuration-error";
 import fetch from "./fetch";
 
-interface GithubUserInfo {
+interface GitHubContributorBase {
   login: string;
+  name: string;
   html_url: string;
 }
 
-export interface GitHubUserResponse extends GithubUserInfo {
-  name: string;
+export interface GithubUserInfo extends GitHubContributorBase {
+  type: string; // "Bot" | "User"
+}
+
+export interface GithubAppInfo extends GitHubContributorBase {
+  slug: string;
 }
 
+export type GitHubContributor = GithubUserInfo | GithubAppInfo;
+
 export interface GitHubIssueResponse {
   number: number;
   title: string;
@@ -54,7 +61,7 @@ export default class GithubAPI {
     return this._fetch(`${prefix}/repos/${repo}/issues/${issue}`);
   }
 
-  public async getUserData(userInfo: GithubUserInfo): Promise<GitHubUserResponse> {
+  public async getUserData(userInfo: Pick<GithubUserInfo, "login" | "html_url">): Promise<GitHubContributor> {
     let login = userInfo.login;
     let path = "users";
 
@@ -63,7 +70,14 @@ export default class GithubAPI {
       login = userInfo.html_url.split("/").pop() as string;
     }
     const prefix = process.env.GITHUB_API_URL || `https://api.${this.github}`;
-    return this._fetch(`${prefix}/${path}/${login}`);
+    const data = await this._fetch(`${prefix}/${path}/${login}`);
+
+    if (login === "Copilot") {
+      // Response for Copilot is "Copilot SWE Agent" - but we prefer "Copilot"
+      data.name = "Copilot";
+    }
+
+    return data;
   }
 
   private async _fetch(url: string): Promise<any> {

src/interfaces.ts

@@ -1,4 +1,4 @@
-import { GitHubIssueResponse, GitHubUserResponse } from "./github-api";
+import { GitHubIssueResponse, GitHubContributor } from "./github-api";
 
 export interface CommitInfo {
   commitSHA: string;
@@ -15,5 +15,5 @@ export interface Release {
   name: string;
   date: string;
   commits: CommitInfo[];
-  contributors?: GitHubUserResponse[];
+  contributors?: GitHubContributor[];
 }

src/markdown-renderer.spec.ts

@@ -1,3 +1,4 @@
+import type { GithubAppInfo, GithubUserInfo } from "./github-api";
 import { CommitInfo, Release } from "./interfaces";
 import MarkdownRenderer from "./markdown-renderer";
 
@@ -120,12 +121,14 @@ describe("MarkdownRenderer", () => {
       const user1 = {
         login: "hzoo",
         name: "",
+        type: "User",
         html_url: "https://github.com/hzoo",
       };
 
       const user2 = {
         login: "Turbo87",
         name: "Tobias Bieniek",
+        type: "User",
         html_url: "https://github.com/Turbo87",
       };
 
@@ -140,6 +143,7 @@ describe("MarkdownRenderer", () => {
       const result = renderer().renderContributor({
         login: "foo",
         name: "",
+        type: "User",
         html_url: "http://github.com/foo",
       });
 
@@ -150,11 +154,23 @@ describe("MarkdownRenderer", () => {
       const result = renderer().renderContributor({
         login: "foo",
         name: "Foo Bar",
+        type: "User",
         html_url: "http://github.com/foo",
       });
 
       expect(result).toEqual("Foo Bar ([@foo](http://github.com/foo))");
     });
+
+    it(`renders Copilot`, () => {
+      const result = renderer().renderContributor({
+        login: "Copilot",
+        name: "Copilot",
+        slug: "copilot-swe-agent",
+        html_url: "https://github.com/apps/copilot-swe-agent",
+      } as GithubAppInfo);
+
+      expect(result).toEqual("Copilot [Bot] ([@copilot-swe-agent](https://github.com/apps/copilot-swe-agent))");
+    });
   });
 
   describe("groupByCategory", () => {
@@ -230,7 +246,7 @@ describe("MarkdownRenderer", () => {
             categories: [":rocket: New Feature"],
           },
         ],
-        contributors: [{ name: "Henry", login: "hzoo", html_url: "http://hzoo.com" }],
+        contributors: [{ name: "Henry", login: "hzoo", type: "User", html_url: "http://hzoo.com" }],
       };
       const options = {
         categories: [":rocket: New Feature"],

src/markdown-renderer.ts

@@ -1,4 +1,4 @@
-import { GitHubUserResponse } from "./github-api";
+import { GitHubContributor, type GithubAppInfo, type GithubUserInfo } from "./github-api";
 import { CommitInfo, Release } from "./interfaces";
 
 const UNRELEASED_TAG = "___unreleased___";
@@ -114,16 +114,19 @@ export default class MarkdownRenderer {
     }
   }
 
-  public renderContributorList(contributors: GitHubUserResponse[]) {
+  public renderContributorList(contributors: GitHubContributor[]) {
     const renderedContributors = contributors.map(contributor => `- ${this.renderContributor(contributor)}`).sort();
 
     return `#### Committers: ${contributors.length}\n${renderedContributors.join("\n")}`;
   }
 
-  public renderContributor(contributor: GitHubUserResponse): string {
-    const userNameAndLink = `[@${contributor.login}](${contributor.html_url})`;
+  public renderContributor(contributor: GitHubContributor): string {
+    const userName = (contributor as GithubAppInfo).slug ?? (contributor as GithubUserInfo).login;
+    const userNameAndLink = `[@${userName}](${contributor.html_url})`;
+
     if (contributor.name) {
-      return `${contributor.name} (${userNameAndLink})`;
+      const name = contributor.name + (!("type" in contributor) ? " [Bot]" : "");
+      return `${name} (${userNameAndLink})`;
     } else {
       return userNameAndLink;
     }

tests/basic-acceptance.test.js

@@ -19,7 +19,7 @@ describe.skipIf(!process.env.GITHUB_AUTH)("command line interface", () => {
 
       #### :rocket: Enhancement
       * \`github-changelog\`
-        * [#33](https://github.com/embroider-build/github-changelog/pull/33) support github enterpise url detection and env vars ([@patricklx](https://github.com/patricklx))
+        * [#33](https://github.com/release-plan/github-changelog/pull/33) support github enterpise url detection and env vars ([@patricklx](https://github.com/patricklx))
 
       #### Committers: 1
       - Patrick Pircher ([@patricklx](https://github.com/patricklx))
@@ -29,10 +29,10 @@ describe.skipIf(!process.env.GITHUB_AUTH)("command line interface", () => {
 
       #### :house: Internal
       * \`github-changelog\`
-        * [#29](https://github.com/embroider-build/github-changelog/pull/29) Prepare Release ([@github-actions[bot]](https://github.com/apps/github-actions))
+        * [#29](https://github.com/release-plan/github-changelog/pull/29) Prepare Release ([@github-actions[bot]](https://github.com/apps/github-actions))
 
       #### Committers: 1
-      - [@github-actions[bot]](https://github.com/apps/github-actions)"
+      - GitHub Actions [Bot] ([@github-actions](https://github.com/apps/github-actions))"
     `);
   });
 
@@ -46,15 +46,15 @@ describe.skipIf(!process.env.GITHUB_AUTH)("command line interface", () => {
 
       #### :rocket: Enhancement
       * \`github-changelog\`
-        * [#33](https://github.com/embroider-build/github-changelog/pull/33) support github enterpise url detection and env vars ([@patricklx](https://github.com/patricklx))
+        * [#33](https://github.com/release-plan/github-changelog/pull/33) support github enterpise url detection and env vars ([@patricklx](https://github.com/patricklx))
 
       #### :house: Internal
       * \`github-changelog\`
-        * [#29](https://github.com/embroider-build/github-changelog/pull/29) Prepare Release ([@github-actions[bot]](https://github.com/apps/github-actions))
+        * [#29](https://github.com/release-plan/github-changelog/pull/29) Prepare Release ([@github-actions[bot]](https://github.com/apps/github-actions))
 
       #### Committers: 2
-      - Patrick Pircher ([@patricklx](https://github.com/patricklx))
-      - [@github-actions[bot]](https://github.com/apps/github-actions)"
+      - GitHub Actions [Bot] ([@github-actions](https://github.com/apps/github-actions))
+      - Patrick Pircher ([@patricklx](https://github.com/patricklx))"
     `);
   });
 });