feat: set login/email on fixed releaser (#18)

src/application/release-event-handler.ts

@@ -43,19 +43,9 @@ export class ReleaseEventHandler {
         const releaseAuthor = event.payload.sender.login;
         console.log(`Release author: ${releaseAuthor}`);
 
-        // Use the release author unless a fixed releaser is configured in config.yml.
-        let releaserUsername = releaseAuthor;
-        if (rulesetRepo.config.fixedReleaser) {
-          releaserUsername = rulesetRepo.config.fixedReleaser;
-          console.log(`Overriding releaser to ${releaserUsername}`);
-        }
-
-        releaser = await this.githubClient.getRepoUser(
-          releaserUsername,
-          new Repository(
-            event.payload.repository.name,
-            event.payload.repository.owner.login
-          )
+        const releaser = await this.determineReleaser(
+          releaseAuthor,
+          rulesetRepo
         );
 
         console.log(
@@ -142,6 +132,35 @@ export class ReleaseEventHandler {
       }
     };
 
+  private async determineReleaser(
+    releaseAuthor: string,
+    rulesetRepo: RulesetRepository
+  ): Promise<User> {
+    // Use the GH release author unless a fixedReleaser is configured
+    let releaserUsername = releaseAuthor;
+    if (rulesetRepo.config.fixedReleaser) {
+      releaserUsername = rulesetRepo.config.fixedReleaser.login;
+      console.log(`Overriding releaser to ${releaserUsername}`);
+    }
+
+    // Fetch the user from GitHub. Note that their email won't be availble
+    // unless it's publicly listed on their profile.
+    const fetchedUser = await this.githubClient.getRepoUser(
+      releaserUsername,
+      rulesetRepo
+    );
+
+    const releaser: User = {
+      username: releaserUsername,
+      name: fetchedUser.name,
+      email: rulesetRepo.config.fixedReleaser
+        ? rulesetRepo.config.fixedReleaser.email
+        : fetchedUser.email,
+    };
+
+    return releaser;
+  }
+
   private async getGitHubWebhookAppAuth(): Promise<GitHubAuth> {
     const [githubAppPrivateKey, githubAppClientId, githubAppClientSecret] =
       await Promise.all([

src/domain/config.ts

@@ -1,3 +1,8 @@
 export interface Configuration {
-  readonly fixedReleaser?: string;
+  readonly fixedReleaser?: FixedReleaser;
+}
+
+export interface FixedReleaser {
+  readonly login: string;
+  readonly email: string;
 }

src/domain/ruleset-repository.spec.ts

@@ -21,6 +21,7 @@ import {
   fakeSourceFile,
 } from "../test/mock-template-files";
 import { expectThrownError } from "../test/util";
+import { FixedReleaser } from "./config";
 
 jest.mock("node:fs");
 jest.mock("../infrastructure/git");
@@ -128,9 +129,15 @@ describe("create", () => {
     });
 
     test("loads a fixedReleaser", async () => {
-      mockRulesetFiles({ configExists: true, fixedReleaser: "jbedard" });
+      mockRulesetFiles({
+        configExists: true,
+        fixedReleaser: { login: "jbedard", email: "[email protected]" },
+      });
       const rulesetRepo = await RulesetRepository.create("foo", "bar", "main");
-      expect(rulesetRepo.config.fixedReleaser).toEqual("jbedard");
+      expect(rulesetRepo.config.fixedReleaser).toEqual({
+        login: "jbedard",
+        email: "[email protected]",
+      });
     });
 
     test("throws on invalid fixedReleaser", async () => {
@@ -258,7 +265,7 @@ function mockRulesetFiles(
     sourceMissingUrl?: boolean;
     invalidPresubmit?: boolean;
     configExists?: boolean;
-    fixedReleaser?: string;
+    fixedReleaser?: FixedReleaser;
     invalidFixedReleaser?: boolean;
   } = {}
 ) {

src/domain/ruleset-repository.ts

@@ -241,14 +241,19 @@ function loadConfiguration(rulesetRepo: RulesetRepository): Configuration {
     return {};
   }
 
-  let config: Record<string, unknown>;
+  let config: Record<string, any>;
   try {
     config = yaml.parse(fs.readFileSync(rulesetRepo.configFilePath, "utf-8"));
   } catch (error) {
     throw new InvalidConfigFileError(rulesetRepo, "cannot parse file as yaml");
   }
 
-  if (config.fixedReleaser && typeof config.fixedReleaser !== "string") {
+  if (
+    config.fixedReleaser &&
+    (typeof config.fixedReleaser !== "object" ||
+      typeof config.fixedReleaser.login !== "string" ||
+      typeof config.fixedReleaser.email !== "string")
+  ) {
     throw new InvalidConfigFileError(
       rulesetRepo,
       "could not parse 'fixedReleaser'"

src/test/mock-template-files.ts

@@ -1,4 +1,5 @@
 import { randomUUID } from "crypto";
+import { FixedReleaser } from "../domain/config";
 
 export function fakeModuleFile(
   overrides: {
@@ -129,14 +130,21 @@ export function fakeMetadataFile(
 }
 
 export function fakeConfigFile(
-  options: { fixedReleaser?: string; invalidFixedReleaser?: boolean } = {}
+  options: {
+    fixedReleaser?: FixedReleaser;
+    invalidFixedReleaser?: boolean;
+  } = {}
 ) {
   if (options.invalidFixedReleaser) {
     return `\
-fixedReleaser: {}
+fixedReleaser: foobar
 `;
   }
   return `\
-${options.fixedReleaser ? `fixedReleaser: ${options.fixedReleaser}` : ""}
+${
+  options.fixedReleaser
+    ? `fixedReleaser: ${JSON.stringify(options.fixedReleaser)}`
+    : ""
+}
 `;
 }

templates/README.md

@@ -80,9 +80,11 @@ The `integrity` hash will automatically be filled out by the app.
 A configuration file to override default behaviour of the app.
 
 ```yaml
-fixedReleaser: <GITHUB_USERNAME>
+fixedReleaser:
+  login: <GITHUB_USERNAME>
+  email: <EMAIL>
 ```
 
-| Field         | Description                                                                                                                                                           |
-| ------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| fixedReleaser | GitHub username (e.g., `kormide`) to author BCR entries. Set this if you want a single user to always be the author of BCR entries regardless of who cut the release. |
+| Field         | Description                                                                                                                                                                  |
+| ------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| fixedReleaser | GitHub username and email to use as the author for BCR commits. Set this if you want a single user to always be the author of BCR entries regardless of who cut the release. |