deploy-vir 3.4.2 → 3.5.0

package/bin.js

@@ -5,4 +5,8 @@ import {join} from 'node:path';
 
 const cliPath = join(import.meta.dirname, 'src', 'cli', 'cli.script.ts');
 
-await runCliScript(cliPath, import.meta.filename, 'deploy-vir');
+await runCliScript({
+    scriptPath: cliPath,
+    cliScriptFilePath: import.meta.filename,
+    binName: 'deploy-vir',
+});

package/dist/commit.d.ts

@@ -1,3 +1,4 @@
+import { type PartialWithUndefined } from '@augment-vir/common';
 import { type DefaultLogFields, type ListLogLine } from 'simple-git';
 /**
  * A git commit.
@@ -8,8 +9,9 @@ export type Commit = DefaultLogFields & ListLogLine;
 /**
  * Extract the human author name for a commit. Commits authored by a bot (a name with a `[bot]`
  * suffix, like GitHub's merge queue bot) are attributed to their first non-bot `Co-authored-by:`
- * trailer instead.
+ * trailer instead. If the commit has no such trailer, its pull request's first non-bot assignee is
+ * used (requires the `gh` CLI). All fallbacks resolve to the original bot name.
  *
  * @category Internal
  */
-export declare function getCommitAuthorName(commit: Readonly<Pick<Commit, 'author_name' | 'body'>>): string;
+export declare function getCommitAuthorName(commit: Readonly<Pick<Commit, 'author_name' | 'body'> & PartialWithUndefined<Pick<Commit, 'hash' | 'message'>>>): Promise<string>;

package/dist/commit.js

@@ -1,13 +1,23 @@
+import { check } from '@augment-vir/assert';
+import { extractErrorMessage, log } from '@augment-vir/common';
+import { runShellCommand } from '@augment-vir/node';
 const coAuthorRegExp = /^co[- \t]*authored[- \t]*by:(.*)$/gim;
+const pullRequestNumberRegExp = /#(\d+)/;
 const botNameSuffix = '[bot]';
+/**
+ * Each `gh` lookup is a network request and each commit's author name gets read more than once (CLI
+ * output and notifications), so results are cached by their lookup key.
+ */
+const pullRequestAssigneeCache = new Map();
 /**
  * Extract the human author name for a commit. Commits authored by a bot (a name with a `[bot]`
  * suffix, like GitHub's merge queue bot) are attributed to their first non-bot `Co-authored-by:`
- * trailer instead.
+ * trailer instead. If the commit has no such trailer, its pull request's first non-bot assignee is
+ * used (requires the `gh` CLI). All fallbacks resolve to the original bot name.
  *
  * @category Internal
  */
-export function getCommitAuthorName(commit) {
+export async function getCommitAuthorName(commit) {
     if (!commit.author_name.endsWith(botNameSuffix)) {
         return commit.author_name;
     }
@@ -15,5 +25,51 @@ export function getCommitAuthorName(commit) {
         /** Strip the trailing `<email>` from each trailer. */
         .map((match) => (match[1] || '').split('<')[0]?.trim())
         .find((name) => name && !name.endsWith(botNameSuffix));
-    return coAuthorName || commit.author_name;
+    return coAuthorName || (await getPullRequestAssigneeName(commit)) || commit.author_name;
+}
+function getPullRequestAssigneeName(commit) {
+    const pullRequestNumber = commit.message?.match(pullRequestNumberRegExp)?.[1];
+    const cacheKey = pullRequestNumber || commit.hash;
+    if (!cacheKey) {
+        return Promise.resolve(undefined);
+    }
+    const cached = pullRequestAssigneeCache.get(cacheKey);
+    if (cached) {
+        return cached;
+    }
+    const pending = fetchPullRequestAssigneeName(pullRequestNumber
+        ? `gh pr view ${pullRequestNumber} --json assignees`
+        : `gh pr list --search ${cacheKey} --state merged --limit 1 --json assignees`);
+    pullRequestAssigneeCache.set(cacheKey, pending);
+    return pending;
+}
+async function fetchPullRequestAssigneeName(command) {
+    try {
+        const output = await runShellCommand(command, {
+            rejectOnError: true,
+        });
+        return extractAssigneeName(JSON.parse(output.stdout));
+    }
+    catch (error) {
+        log.faint(`Failed to read a pull request assignee: ${extractErrorMessage(error)}`);
+        return undefined;
+    }
+}
+function extractAssigneeName(parsedJson) {
+    /** `gh pr list` outputs an array, `gh pr view` outputs a single pull request. */
+    const pullRequest = check.isArray(parsedJson) ? parsedJson[0] : parsedJson;
+    if (!check.hasKey(pullRequest, 'assignees') || !check.isArray(pullRequest.assignees)) {
+        return undefined;
+    }
+    return pullRequest.assignees
+        .map((assignee) => {
+        const name = check.hasKey(assignee, 'name') && check.isString(assignee.name)
+            ? assignee.name
+            : '';
+        const login = check.hasKey(assignee, 'login') && check.isString(assignee.login)
+            ? assignee.login
+            : '';
+        return name || login;
+    })
+        .find((name) => name && !name.endsWith(botNameSuffix));
 }

package/dist/git.js

@@ -1,5 +1,5 @@
 import { assert, assertWrap, check } from '@augment-vir/assert';
-import { awaitedBlockingMap, log, logColors } from '@augment-vir/common';
+import { awaitedBlockingMap, awaitedForEach, log, logColors } from '@augment-vir/common';
 import { confirm } from '@inquirer/prompts';
 import { getCommitAuthorName } from './commit.js';
 import { KnownError } from './known.error.js';
@@ -13,7 +13,9 @@ export async function getGitRemoteName(git, repoConfig) {
     assert.isTruthy(repoConfig.name, 'Repo config name cannot be empty.');
     assert.isTruthy(repoConfig.gitUrl, 'Repo git URL cannot be empty.');
     const remotes = await git.getRemotes(true);
-    const remoteMatchByUrl = remotes.find((remote) => remote.refs.fetch === repoConfig.gitUrl || remote.refs.push === repoConfig.gitUrl);
+    const remoteMatchByUrl = remotes.find((remote) => {
+        return remote.refs.fetch === repoConfig.gitUrl || remote.refs.push === repoConfig.gitUrl;
+    });
     if (remoteMatchByUrl) {
         return remoteMatchByUrl.name;
     }
@@ -65,13 +67,13 @@ export async function pushDeploy(git, branchConfig, repoConfig, remoteName, noti
         ])).all;
         const requiresForcePush = commitsBehind.length > 0;
         log.info(`\n${requiresForcePush ? 'Only on' : 'Releasing from'} ${logColors.bold}${fromBranch}${logColors.reset}:`);
-        commitsAhead.forEach((commit, index) => {
-            log.faint(`    ${index + 1}. ${commit.hash.slice(0, 7)} (${getCommitAuthorName(commit)}) - ${commit.message}`);
+        await awaitedForEach(commitsAhead, async (commit, index) => {
+            log.faint(`    ${index + 1}. ${commit.hash.slice(0, 7)} (${await getCommitAuthorName(commit)}) - ${commit.message}`);
         });
         if (requiresForcePush) {
             log.info(`\nOnly on ${logColors.bold}${toBranch}${logColors.reset}:`);
-            commitsBehind.forEach((commit, index) => {
-                log.faint(`    ${index + 1}. ${commit.hash.slice(0, 7)} (${getCommitAuthorName(commit)}) - ${commit.message}`);
+            await awaitedForEach(commitsBehind, async (commit, index) => {
+                log.faint(`    ${index + 1}. ${commit.hash.slice(0, 7)} (${await getCommitAuthorName(commit)}) - ${commit.message}`);
             });
         }
         const shouldPush = bypassConfirmation ||

package/dist/notifications/slack.js

@@ -9,12 +9,13 @@ function truncateString(value, truncateAt = 100) {
         return value;
     }
 }
-function formatCommit(baseCommitUrl, commit) {
+async function formatCommit(baseCommitUrl, commit) {
+    const authorName = await getCommitAuthorName(commit);
     if (baseCommitUrl) {
-        return `<${joinUrlPaths(baseCommitUrl, commit.hash)}|${commit.hash.slice(0, 7)}> (${getCommitAuthorName(commit)}) ${truncateString(commit.message)}`;
+        return `<${joinUrlPaths(baseCommitUrl, commit.hash)}|${commit.hash.slice(0, 7)}> (${authorName}) ${truncateString(commit.message)}`;
     }
     else {
-        return `${commit.hash.slice(0, 7)} (${getCommitAuthorName(commit)}) ${truncateString(commit.message)}`;
+        return `${commit.hash.slice(0, 7)} (${authorName}) ${truncateString(commit.message)}`;
     }
 }
 const slackMaxSectionLength = 2500;
@@ -43,8 +44,8 @@ function chunkSectionLines(lines) {
  * @category Internal
  */
 export async function sendNotificationToSlack({ deployResult: { deployCommits: { deployedCommits, overwrittenCommits }, branchStatus: { after, before }, toBranchName, }, hookResult, notification, repoConfig, }) {
-    const deployedCommitBullets = deployedCommits.map((commit) => formatCommit(repoConfig.commitBaseUrl, commit));
-    const overwrittenCommitBullets = overwrittenCommits.map((commit) => formatCommit(repoConfig.commitBaseUrl, commit));
+    const deployedCommitBullets = await Promise.all(deployedCommits.map(async (commit) => await formatCommit(repoConfig.commitBaseUrl, commit)));
+    const overwrittenCommitBullets = await Promise.all(overwrittenCommits.map(async (commit) => await formatCommit(repoConfig.commitBaseUrl, commit)));
     const deployedCommitBulletLines = deployedCommitBullets.map((bullet) => `- ${bullet}`);
     const overwrittenCommitBulletLines = overwrittenCommitBullets.length
         ? overwrittenCommitBullets.map((bullet) => `- ${bullet}`)

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "deploy-vir",
-    "version": "3.4.2",
+    "version": "3.5.0",
     "description": "Deploy a branch to another branch with notifications.",
     "keywords": [
         "deploy",
@@ -42,39 +42,39 @@
         "test:update": "npm run test update"
     },
     "dependencies": {
-        "@augment-vir/assert": "^32.2.1",
-        "@augment-vir/common": "^32.2.1",
-        "@augment-vir/node": "^32.2.1",
+        "@augment-vir/assert": "^32.2.2",
+        "@augment-vir/common": "^32.2.2",
+        "@augment-vir/node": "^32.2.2",
         "@inquirer/prompts": "^8.5.2",
         "@slack/web-api": "^8.0.0",
-        "cli-vir": "^1.0.4",
+        "cli-vir": "^1.0.5",
         "simple-git": "^3.36.0",
-        "tsx": "^4.23.1",
-        "url-vir": "^2.1.10"
+        "tsx": "^4.23.12",
+        "url-vir": "^2.2.1"
     },
     "devDependencies": {
-        "@augment-vir/test": "^32.2.1",
+        "@augment-vir/test": "^32.2.2",
         "@eslint/eslintrc": "^3.3.6",
         "@eslint/js": "^10.0.1",
         "@stylistic/eslint-plugin": "^5.10.0",
         "@stylistic/eslint-plugin-ts": "^4.4.1",
-        "@types/node": "^26.1.1",
-        "@typescript-eslint/eslint-plugin": "^8.65.0",
+        "@types/node": "^26.2.0",
+        "@typescript-eslint/eslint-plugin": "^8.66.0",
         "cspell": "^10.0.1",
-        "dependency-cruiser": "^18.1.0",
-        "esbuild": "^0.28.1",
-        "eslint": "^10.8.0",
+        "dependency-cruiser": "^18.1.1",
+        "esbuild": "^0.28.2",
+        "eslint": "^10.8.1",
         "eslint-config-prettier": "^10.1.8",
-        "eslint-plugin-jsdoc": "^63.2.2",
+        "eslint-plugin-jsdoc": "^64.0.2",
         "eslint-plugin-monorepo-cop": "^1.0.2",
-        "eslint-plugin-playwright": "^2.10.5",
+        "eslint-plugin-playwright": "^2.11.0",
         "eslint-plugin-prettier": "^5.5.6",
         "eslint-plugin-require-extensions": "^0.1.3",
         "eslint-plugin-sonarjs": "^4.2.0",
-        "eslint-plugin-unicorn": "^72.0.0",
+        "eslint-plugin-unicorn": "^73.0.0",
         "istanbul-smart-text-reporter": "^1.1.5",
         "markdown-code-example-inserter": "^3.0.6",
-        "npm-check-updates": "^22.2.9",
+        "npm-check-updates": "^23.0.2",
         "prettier": "~3.3.3",
         "prettier-plugin-interpolated-html-tags": "^2.0.2",
         "prettier-plugin-jsdoc": "^1.8.1",
@@ -86,8 +86,8 @@
         "runstorm": "^1.0.6",
         "typedoc": "^0.28.20",
         "typescript": "^6.0.3",
-        "typescript-eslint": "^8.65.0",
-        "virmator": "^14.30.1"
+        "typescript-eslint": "^8.66.0",
+        "virmator": "^14.30.6"
     },
     "engines": {
         "node": ">=22"

package/src/commit.ts

@@ -1,3 +1,6 @@
+import {check} from '@augment-vir/assert';
+import {extractErrorMessage, log, type PartialWithUndefined} from '@augment-vir/common';
+import {runShellCommand} from '@augment-vir/node';
 import {type DefaultLogFields, type ListLogLine} from 'simple-git';
 
 /**
@@ -8,18 +11,29 @@ import {type DefaultLogFields, type ListLogLine} from 'simple-git';
 export type Commit = DefaultLogFields & ListLogLine;
 
 const coAuthorRegExp = /^co[- \t]*authored[- \t]*by:(.*)$/gim;
+const pullRequestNumberRegExp = /#(\d+)/;
 const botNameSuffix = '[bot]';
 
+/**
+ * Each `gh` lookup is a network request and each commit's author name gets read more than once (CLI
+ * output and notifications), so results are cached by their lookup key.
+ */
+const pullRequestAssigneeCache = new Map<string, Promise<string | undefined>>();
+
 /**
  * Extract the human author name for a commit. Commits authored by a bot (a name with a `[bot]`
  * suffix, like GitHub's merge queue bot) are attributed to their first non-bot `Co-authored-by:`
- * trailer instead.
+ * trailer instead. If the commit has no such trailer, its pull request's first non-bot assignee is
+ * used (requires the `gh` CLI). All fallbacks resolve to the original bot name.
  *
  * @category Internal
  */
-export function getCommitAuthorName(
-    commit: Readonly<Pick<Commit, 'author_name' | 'body'>>,
-): string {
+export async function getCommitAuthorName(
+    commit: Readonly<
+        Pick<Commit, 'author_name' | 'body'> &
+            PartialWithUndefined<Pick<Commit, 'hash' | 'message'>>
+    >,
+): Promise<string> {
     if (!commit.author_name.endsWith(botNameSuffix)) {
         return commit.author_name;
     }
@@ -29,5 +43,68 @@ export function getCommitAuthorName(
         .map((match) => (match[1] || '').split('<')[0]?.trim())
         .find((name) => name && !name.endsWith(botNameSuffix));
 
-    return coAuthorName || commit.author_name;
+    return coAuthorName || (await getPullRequestAssigneeName(commit)) || commit.author_name;
+}
+
+function getPullRequestAssigneeName(
+    commit: Readonly<PartialWithUndefined<Pick<Commit, 'hash' | 'message'>>>,
+): Promise<string | undefined> {
+    const pullRequestNumber = commit.message?.match(pullRequestNumberRegExp)?.[1];
+    const cacheKey = pullRequestNumber || commit.hash;
+
+    if (!cacheKey) {
+        return Promise.resolve(undefined);
+    }
+
+    const cached = pullRequestAssigneeCache.get(cacheKey);
+
+    if (cached) {
+        return cached;
+    }
+
+    const pending = fetchPullRequestAssigneeName(
+        pullRequestNumber
+            ? `gh pr view ${pullRequestNumber} --json assignees`
+            : `gh pr list --search ${cacheKey} --state merged --limit 1 --json assignees`,
+    );
+    pullRequestAssigneeCache.set(cacheKey, pending);
+
+    return pending;
+}
+
+async function fetchPullRequestAssigneeName(command: string): Promise<string | undefined> {
+    try {
+        const output = await runShellCommand(command, {
+            rejectOnError: true,
+        });
+
+        return extractAssigneeName(JSON.parse(output.stdout));
+    } catch (error) {
+        log.faint(`Failed to read a pull request assignee: ${extractErrorMessage(error)}`);
+        return undefined;
+    }
+}
+
+function extractAssigneeName(parsedJson: unknown): string | undefined {
+    /** `gh pr list` outputs an array, `gh pr view` outputs a single pull request. */
+    const pullRequest = check.isArray(parsedJson) ? parsedJson[0] : parsedJson;
+
+    if (!check.hasKey(pullRequest, 'assignees') || !check.isArray(pullRequest.assignees)) {
+        return undefined;
+    }
+
+    return pullRequest.assignees
+        .map((assignee) => {
+            const name =
+                check.hasKey(assignee, 'name') && check.isString(assignee.name)
+                    ? assignee.name
+                    : '';
+            const login =
+                check.hasKey(assignee, 'login') && check.isString(assignee.login)
+                    ? assignee.login
+                    : '';
+
+            return name || login;
+        })
+        .find((name) => name && !name.endsWith(botNameSuffix));
 }

package/src/git.ts

@@ -1,5 +1,5 @@
 import {assert, assertWrap, check} from '@augment-vir/assert';
-import {awaitedBlockingMap, log, logColors} from '@augment-vir/common';
+import {awaitedBlockingMap, awaitedForEach, log, logColors} from '@augment-vir/common';
 import {confirm} from '@inquirer/prompts';
 import {type SimpleGit} from 'simple-git';
 import {getCommitAuthorName, type Commit} from './commit.js';
@@ -27,10 +27,9 @@ export async function getGitRemoteName(
 
     const remotes = await git.getRemotes(true);
 
-    const remoteMatchByUrl = remotes.find(
-        (remote) =>
-            remote.refs.fetch === repoConfig.gitUrl || remote.refs.push === repoConfig.gitUrl,
-    );
+    const remoteMatchByUrl = remotes.find((remote) => {
+        return remote.refs.fetch === repoConfig.gitUrl || remote.refs.push === repoConfig.gitUrl;
+    });
 
     if (remoteMatchByUrl) {
         return remoteMatchByUrl.name;
@@ -157,17 +156,17 @@ export async function pushDeploy(
             log.info(
                 `\n${requiresForcePush ? 'Only on' : 'Releasing from'} ${logColors.bold}${fromBranch}${logColors.reset}:`,
             );
-            commitsAhead.forEach((commit, index) => {
+            await awaitedForEach(commitsAhead, async (commit, index) => {
                 log.faint(
-                    `    ${index + 1}. ${commit.hash.slice(0, 7)} (${getCommitAuthorName(commit)}) - ${commit.message}`,
+                    `    ${index + 1}. ${commit.hash.slice(0, 7)} (${await getCommitAuthorName(commit)}) - ${commit.message}`,
                 );
             });
 
             if (requiresForcePush) {
                 log.info(`\nOnly on ${logColors.bold}${toBranch}${logColors.reset}:`);
-                commitsBehind.forEach((commit, index) => {
+                await awaitedForEach(commitsBehind, async (commit, index) => {
                     log.faint(
-                        `    ${index + 1}. ${commit.hash.slice(0, 7)} (${getCommitAuthorName(commit)}) - ${commit.message}`,
+                        `    ${index + 1}. ${commit.hash.slice(0, 7)} (${await getCommitAuthorName(commit)}) - ${commit.message}`,
                     );
                 });
             }

package/src/notifications/slack.ts

@@ -15,11 +15,13 @@ function truncateString(value: string, truncateAt = 100): string {
     }
 }
 
-function formatCommit(baseCommitUrl: string | undefined, commit: Readonly<Commit>) {
+async function formatCommit(baseCommitUrl: string | undefined, commit: Readonly<Commit>) {
+    const authorName = await getCommitAuthorName(commit);
+
     if (baseCommitUrl) {
-        return `<${joinUrlPaths(baseCommitUrl, commit.hash)}|${commit.hash.slice(0, 7)}> (${getCommitAuthorName(commit)}) ${truncateString(commit.message)}`;
+        return `<${joinUrlPaths(baseCommitUrl, commit.hash)}|${commit.hash.slice(0, 7)}> (${authorName}) ${truncateString(commit.message)}`;
     } else {
-        return `${commit.hash.slice(0, 7)} (${getCommitAuthorName(commit)}) ${truncateString(commit.message)}`;
+        return `${commit.hash.slice(0, 7)} (${authorName}) ${truncateString(commit.message)}`;
     }
 }
 
@@ -65,11 +67,13 @@ export async function sendNotificationToSlack({
     notification,
     repoConfig,
 }: Readonly<NotificationParams>) {
-    const deployedCommitBullets = deployedCommits.map((commit) =>
-        formatCommit(repoConfig.commitBaseUrl, commit),
+    const deployedCommitBullets = await Promise.all(
+        deployedCommits.map(async (commit) => await formatCommit(repoConfig.commitBaseUrl, commit)),
     );
-    const overwrittenCommitBullets = overwrittenCommits.map((commit) =>
-        formatCommit(repoConfig.commitBaseUrl, commit),
+    const overwrittenCommitBullets = await Promise.all(
+        overwrittenCommits.map(
+            async (commit) => await formatCommit(repoConfig.commitBaseUrl, commit),
+        ),
     );
 
     const deployedCommitBulletLines = deployedCommitBullets.map((bullet) => `- ${bullet}`);