deploy-vir 3.4.1 → 3.4.2

package/dist/commit.d.ts

@@ -0,0 +1,15 @@
+import { type DefaultLogFields, type ListLogLine } from 'simple-git';
+/**
+ * A git commit.
+ *
+ * @category Internal
+ */
+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.
+ *
+ * @category Internal
+ */
+export declare function getCommitAuthorName(commit: Readonly<Pick<Commit, 'author_name' | 'body'>>): string;

package/dist/commit.js

@@ -0,0 +1,19 @@
+const coAuthorRegExp = /^co[- \t]*authored[- \t]*by:(.*)$/gim;
+const botNameSuffix = '[bot]';
+/**
+ * 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.
+ *
+ * @category Internal
+ */
+export function getCommitAuthorName(commit) {
+    if (!commit.author_name.endsWith(botNameSuffix)) {
+        return commit.author_name;
+    }
+    const coAuthorName = Array.from(commit.body.matchAll(coAuthorRegExp))
+        /** 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;
+}

package/dist/config.d.ts

@@ -1,5 +1,6 @@
 import { type MaybePromise, type PartialWithUndefined } from '@augment-vir/common';
-import { type Commit, type DeployResult } from './git.js';
+import { type Commit } from './commit.js';
+import { type DeployResult } from './git.js';
 /**
  * The full deploy-vir config object.
  *

package/dist/git.d.ts

@@ -1,4 +1,5 @@
-import { type DefaultLogFields, type ListLogLine, type SimpleGit } from 'simple-git';
+import { type SimpleGit } from 'simple-git';
+import { type Commit } from './commit.js';
 import { type DeployVirBranchConfig, type DeployVirHooks, type DeployVirRepoConfig, type NotificationConfig } from './config.js';
 /**
  * Find the git remote's name, or create a new one.
@@ -6,12 +7,6 @@ import { type DeployVirBranchConfig, type DeployVirHooks, type DeployVirRepoConf
  * @category Internal
  */
 export declare function getGitRemoteName(git: Readonly<SimpleGit>, repoConfig: Readonly<Pick<DeployVirRepoConfig, 'name' | 'gitUrl'>>): Promise<string>;
-/**
- * A git commit.
- *
- * @category Internal
- */
-export type Commit = DefaultLogFields & ListLogLine;
 /**
  * All commits involved in a deploy.
  *

package/dist/git.js

@@ -1,6 +1,7 @@
 import { assert, assertWrap, check } from '@augment-vir/assert';
 import { awaitedBlockingMap, log, logColors } from '@augment-vir/common';
 import { confirm } from '@inquirer/prompts';
+import { getCommitAuthorName } from './commit.js';
 import { KnownError } from './known.error.js';
 import { sendNotifications } from './notifications/send-notifications.js';
 /**
@@ -65,12 +66,12 @@ export async function pushDeploy(git, branchConfig, repoConfig, remoteName, noti
         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)} (${commit.author_name}) - ${commit.message}`);
+            log.faint(`    ${index + 1}. ${commit.hash.slice(0, 7)} (${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)} (${commit.author_name}) - ${commit.message}`);
+                log.faint(`    ${index + 1}. ${commit.hash.slice(0, 7)} (${getCommitAuthorName(commit)}) - ${commit.message}`);
             });
         }
         const shouldPush = bypassConfirmation ||

package/dist/index.d.ts

@@ -1,4 +1,5 @@
 export * from './cli/cli.js';
+export * from './commit.js';
 export * from './config.js';
 export * from './git.js';
 export * from './known.error.js';

package/dist/index.js

@@ -1,4 +1,5 @@
 export * from './cli/cli.js';
+export * from './commit.js';
 export * from './config.js';
 export * from './git.js';
 export * from './known.error.js';

package/dist/notifications/slack.js

@@ -1,5 +1,6 @@
 import { addPrefix, log, setFirstLetterCasing, StringCase } from '@augment-vir/common';
 import { joinUrlPaths } from 'url-vir';
+import { getCommitAuthorName } from '../commit.js';
 function truncateString(value, truncateAt = 100) {
     if (value.length > truncateAt) {
         return `${value.slice(0, Math.max(0, truncateAt))}...`;
@@ -10,10 +11,10 @@ function truncateString(value, truncateAt = 100) {
 }
 function formatCommit(baseCommitUrl, commit) {
     if (baseCommitUrl) {
-        return `<${joinUrlPaths(baseCommitUrl, commit.hash)}|${commit.hash.slice(0, 7)}> (${commit.author_name}) ${truncateString(commit.message)}`;
+        return `<${joinUrlPaths(baseCommitUrl, commit.hash)}|${commit.hash.slice(0, 7)}> (${getCommitAuthorName(commit)}) ${truncateString(commit.message)}`;
     }
     else {
-        return `${commit.hash.slice(0, 7)} (${commit.author_name}) ${truncateString(commit.message)}`;
+        return `${commit.hash.slice(0, 7)} (${getCommitAuthorName(commit)}) ${truncateString(commit.message)}`;
     }
 }
 const slackMaxSectionLength = 2500;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "deploy-vir",
-    "version": "3.4.1",
+    "version": "3.4.2",
     "description": "Deploy a branch to another branch with notifications.",
     "keywords": [
         "deploy",
@@ -32,7 +32,8 @@
         "format": "virmator format",
         "lint": "virmator lint fix",
         "publish": "virmator publish npm run test:all",
-        "test:all": "npm run compile && runstorm --names spelling,format,docs,deps,lint \"npm run test:spelling\" \"npm run test:format\" \"npm run test:docs\" \"npm run test:deps\" \"npm run test:lint\"",
+        "test": "virmator test node",
+        "test:all": "npm run compile && runstorm --names spelling,format,docs,deps,lint,test \"npm run test:spelling\" \"npm run test:format\" \"npm run test:docs\" \"npm run test:deps\" \"npm run test:lint\" \"npm test\"",
         "test:deps": "virmator deps check",
         "test:docs": "virmator docs check",
         "test:format": "virmator format check",
@@ -52,6 +53,7 @@
         "url-vir": "^2.1.10"
     },
     "devDependencies": {
+        "@augment-vir/test": "^32.2.1",
         "@eslint/eslintrc": "^3.3.6",
         "@eslint/js": "^10.0.1",
         "@stylistic/eslint-plugin": "^5.10.0",

package/src/commit.ts

@@ -0,0 +1,33 @@
+import {type DefaultLogFields, type ListLogLine} from 'simple-git';
+
+/**
+ * A git commit.
+ *
+ * @category Internal
+ */
+export type Commit = DefaultLogFields & ListLogLine;
+
+const coAuthorRegExp = /^co[- \t]*authored[- \t]*by:(.*)$/gim;
+const botNameSuffix = '[bot]';
+
+/**
+ * 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.
+ *
+ * @category Internal
+ */
+export function getCommitAuthorName(
+    commit: Readonly<Pick<Commit, 'author_name' | 'body'>>,
+): string {
+    if (!commit.author_name.endsWith(botNameSuffix)) {
+        return commit.author_name;
+    }
+
+    const coAuthorName = Array.from(commit.body.matchAll(coAuthorRegExp))
+        /** 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;
+}

package/src/config.ts

@@ -1,5 +1,6 @@
 import {type MaybePromise, type PartialWithUndefined} from '@augment-vir/common';
-import {type Commit, type DeployResult} from './git.js';
+import {type Commit} from './commit.js';
+import {type DeployResult} from './git.js';
 
 /**
  * The full deploy-vir config object.

package/src/git.ts

@@ -1,7 +1,8 @@
 import {assert, assertWrap, check} from '@augment-vir/assert';
 import {awaitedBlockingMap, log, logColors} from '@augment-vir/common';
 import {confirm} from '@inquirer/prompts';
-import {type DefaultLogFields, type ListLogLine, type SimpleGit} from 'simple-git';
+import {type SimpleGit} from 'simple-git';
+import {getCommitAuthorName, type Commit} from './commit.js';
 import {
     type DeployNotificationConfig,
     type DeployVirBranchConfig,
@@ -52,13 +53,6 @@ export async function getGitRemoteName(
     return newRemoteName;
 }
 
-/**
- * A git commit.
- *
- * @category Internal
- */
-export type Commit = DefaultLogFields & ListLogLine;
-
 /**
  * All commits involved in a deploy.
  *
@@ -165,7 +159,7 @@ export async function pushDeploy(
             );
             commitsAhead.forEach((commit, index) => {
                 log.faint(
-                    `    ${index + 1}. ${commit.hash.slice(0, 7)} (${commit.author_name}) - ${commit.message}`,
+                    `    ${index + 1}. ${commit.hash.slice(0, 7)} (${getCommitAuthorName(commit)}) - ${commit.message}`,
                 );
             });
 
@@ -173,7 +167,7 @@ export async function pushDeploy(
                 log.info(`\nOnly on ${logColors.bold}${toBranch}${logColors.reset}:`);
                 commitsBehind.forEach((commit, index) => {
                     log.faint(
-                        `    ${index + 1}. ${commit.hash.slice(0, 7)} (${commit.author_name}) - ${commit.message}`,
+                        `    ${index + 1}. ${commit.hash.slice(0, 7)} (${getCommitAuthorName(commit)}) - ${commit.message}`,
                     );
                 });
             }

package/src/index.ts

@@ -1,4 +1,5 @@
 export * from './cli/cli.js';
+export * from './commit.js';
 export * from './config.js';
 export * from './git.js';
 export * from './known.error.js';

package/src/notifications/slack.ts

@@ -1,8 +1,8 @@
 import {addPrefix, log, setFirstLetterCasing, StringCase} from '@augment-vir/common';
 import {type ChatPostMessageArguments, type KnownBlock} from '@slack/web-api';
 import {joinUrlPaths} from 'url-vir';
+import {getCommitAuthorName, type Commit} from '../commit.js';
 import {type SlackNotificationConfig} from '../config.js';
-import {type Commit} from '../git.js';
 import {type NotificationParams} from './notification-params.js';
 
 export {type ChatPostMessageArguments} from '@slack/web-api';
@@ -17,9 +17,9 @@ function truncateString(value: string, truncateAt = 100): string {
 
 function formatCommit(baseCommitUrl: string | undefined, commit: Readonly<Commit>) {
     if (baseCommitUrl) {
-        return `<${joinUrlPaths(baseCommitUrl, commit.hash)}|${commit.hash.slice(0, 7)}> (${commit.author_name}) ${truncateString(commit.message)}`;
+        return `<${joinUrlPaths(baseCommitUrl, commit.hash)}|${commit.hash.slice(0, 7)}> (${getCommitAuthorName(commit)}) ${truncateString(commit.message)}`;
     } else {
-        return `${commit.hash.slice(0, 7)} (${commit.author_name}) ${truncateString(commit.message)}`;
+        return `${commit.hash.slice(0, 7)} (${getCommitAuthorName(commit)}) ${truncateString(commit.message)}`;
     }
 }