deploy-vir 0.1.1 → 0.2.1

package/dist/cli/cli.js

@@ -1,5 +1,6 @@
 import { assertWrap } from '@augment-vir/assert';
 import { extractErrorMessage, log } from '@augment-vir/common';
+import { resolve } from 'node:path';
 import simpleGit from 'simple-git';
 import { getGitRemoteName, pushDeploy } from '../git.js';
 import { KnownError } from '../known.error.js';
@@ -13,7 +14,7 @@ export async function runDeployVirCli(args, cwd = process.cwd()) {
     const configPath = assertWrap.isTruthy(args[0], 'Missing config path.');
     const repoName = assertWrap.isTruthy(args[1], 'Missing repo name.');
     const deployName = assertWrap.isTruthy(args[2], 'Missing deploy name.');
-    const config = (await import(configPath)).default;
+    const config = (await import(resolve(cwd, configPath))).default;
     await runDeployVir({ cwd, deployName, repoName }, config);
 }
 /**
@@ -28,11 +29,11 @@ export async function runDeployVir(args, config) {
         const branchConfig = assertWrap.isDefined(repoConfig.deploys.find((deploy) => deploy.deployName === args.deployName, `Failed to find a deploy named '${args.deployName}' in repo '${args.repoName}'.`));
         const remoteName = await getGitRemoteName(git, repoConfig);
         log.faint(`Remote: ${remoteName}`);
-        const deployCommits = await pushDeploy(git, branchConfig, remoteName);
+        const deployResult = await pushDeploy(git, branchConfig, remoteName);
         if (config.notifications?.length) {
             await sendNotifications(config.notifications, {
                 branchConfig,
-                deployCommits,
+                deployResult,
                 repoConfig,
             });
         }

package/dist/git.d.ts

@@ -21,9 +21,27 @@ export type DeployCommits = {
     deployedCommits: ReadonlyArray<Readonly<Commit>>;
     overwrittenCommits: ReadonlyArray<Readonly<Commit>>;
 };
+/**
+ * Before/after of the branch deployed to.
+ *
+ * @category Internal
+ */
+export type DeployBranchStatus = {
+    before: Readonly<Commit>;
+    after: Readonly<Commit>;
+};
+/**
+ * Output from {@link pushDeploy}.
+ *
+ * @category Internal
+ */
+export type DeployResult = {
+    deployCommits: DeployCommits;
+    branchStatus: DeployBranchStatus;
+};
 /**
  * Push the deploy via git.
  *
  * @category Internal
  */
-export declare function pushDeploy(git: Readonly<SimpleGit>, { deployName, fromBranch, toBranch }: Readonly<DeployVirBranchConfig>, remoteName: string): Promise<DeployCommits>;
+export declare function pushDeploy(git: Readonly<SimpleGit>, { deployName, fromBranch, toBranch }: Readonly<DeployVirBranchConfig>, remoteName: string): Promise<DeployResult>;

package/dist/git.js

@@ -1,4 +1,4 @@
-import { assert, check } from '@augment-vir/assert';
+import { assert, assertWrap, check } from '@augment-vir/assert';
 import { extractErrorMessage, log, logColors } from '@augment-vir/common';
 import { askQuestion } from '@augment-vir/node';
 import { KnownError } from './known.error.js';
@@ -36,32 +36,46 @@ export async function pushDeploy(git, { deployName, fromBranch, toBranch }, remo
     assert.isTruthy(remoteName, 'Remote name cannot be empty.');
     log.faint(`Pushing ${remoteName}/${fromBranch} to ${toBranch}`);
     await git.fetch(remoteName, fromBranch);
+    await git.fetch(remoteName, toBranch);
     const pushString = `${remoteName}/${fromBranch}:${toBranch}`;
+    // Get the current commit on the target branch before pushing
+    const beforeCommit = assertWrap.isDefined((await git.log([
+        `${remoteName}/${toBranch}`,
+        '-1',
+    ])).latest, `Failed to get current commit for ${remoteName}/${toBranch}`);
+    const afterCommit = assertWrap.isDefined((await git.log([
+        `${remoteName}/${fromBranch}`,
+        '-1',
+    ])).latest, `Failed to get current commit for ${remoteName}/${fromBranch}`);
     /** Get commits that are on {@link toBranch} but not on {@link fromBranch}. */
-    const commitsAhead = (await git.log({
-        from: `${remoteName}/${toBranch}`,
-        to: `${remoteName}/${fromBranch}`,
-    })).all;
+    const commitsAhead = (await git.log([
+        '${remoteName}/${toBranch}..${remoteName}/${fromBranch}',
+    ])).all;
     if (!commitsAhead.length) {
         throw new KnownError('No commit diff: nothing to deploy!');
     }
     try {
         await git.push(remoteName, pushString);
         return {
-            deployedCommits: commitsAhead,
-            overwrittenCommits: [],
+            deployCommits: {
+                deployedCommits: commitsAhead,
+                overwrittenCommits: [],
+            },
+            branchStatus: {
+                before: beforeCommit,
+                after: afterCommit,
+            },
         };
     }
     catch (error) {
         log.error(`Push failed: ${extractErrorMessage(error)}`);
         /** Get commits that are on {@link toBranch} but not on {@link fromBranch}. */
-        const commitsBehind = await git.log({
-            from: `${remoteName}/${fromBranch}`,
-            to: `${remoteName}/${toBranch}`,
-        });
-        if (commitsBehind.total > 0) {
-            log.info(`\nThe following ${commitsBehind.total} commit${commitsBehind.total === 1 ? '' : 's'} are on ${logColors.bold}${toBranch}${logColors.reset} but not on ${logColors.bold}${fromBranch}${logColors.reset}:`);
-            commitsBehind.all.forEach((commit, index) => {
+        const commitsBehind = (await git.log([
+            '${remoteName}/${fromBranch}..${remoteName}/${toBranch}',
+        ])).all;
+        if (commitsBehind.length > 0) {
+            log.info(`\nThe following ${commitsBehind.length} commit${commitsBehind.length === 1 ? '' : 's'} are on ${logColors.bold}${toBranch}${logColors.reset} but not on ${logColors.bold}${fromBranch}${logColors.reset}:`);
+            commitsBehind.forEach((commit, index) => {
                 log.faint(`    ${index + 1}. ${commit.hash.slice(0, 7)} (${commit.author_name}) - ${commit.message}`);
             });
         }
@@ -74,8 +88,14 @@ export async function pushDeploy(git, { deployName, fromBranch, toBranch }, remo
             throw new KnownError(`Deploy aborted.`);
         }
         return {
-            deployedCommits: commitsAhead,
-            overwrittenCommits: commitsBehind.all,
+            deployCommits: {
+                deployedCommits: commitsAhead,
+                overwrittenCommits: commitsBehind,
+            },
+            branchStatus: {
+                before: beforeCommit,
+                after: afterCommit,
+            },
         };
     }
 }

package/dist/notifications/notification-params.d.ts

@@ -1,12 +1,12 @@
 import { type DeployVirBranchConfig, type DeployVirRepoConfig, type NotificationConfig, type NotificationTarget } from '../config.js';
-import { type DeployCommits } from '../git.js';
+import { type DeployResult } from '../git.js';
 /**
  * Params for sending a notification.
  *
  * @category Internal
  */
 export type NotificationParams<Target extends NotificationTarget = NotificationTarget> = {
-    deployCommits: Readonly<DeployCommits>;
+    deployResult: Readonly<DeployResult>;
     branchConfig: Readonly<DeployVirBranchConfig>;
     repoConfig: Readonly<Pick<DeployVirRepoConfig, 'commitBaseUrl'>>;
     notification: Readonly<Extract<NotificationConfig, {

package/dist/notifications/send-notifications.d.ts

@@ -5,4 +5,4 @@ import { type NotificationParams } from './notification-params.js';
  *
  * @category Internal
  */
-export declare function sendNotifications(notifications: ReadonlyArray<Readonly<NotificationConfig>>, { branchConfig, deployCommits, repoConfig }: Readonly<Omit<NotificationParams, 'notification'>>): Promise<void>;
+export declare function sendNotifications(notifications: ReadonlyArray<Readonly<NotificationConfig>>, params: Readonly<Omit<NotificationParams, 'notification'>>): Promise<void>;

package/dist/notifications/send-notifications.js

@@ -6,14 +6,12 @@ import { sendNotificationToSlack } from './slack.js';
  *
  * @category Internal
  */
-export async function sendNotifications(notifications, { branchConfig, deployCommits, repoConfig }) {
+export async function sendNotifications(notifications, params) {
     await Promise.all(notifications.map(async (notification) => {
         // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
         if (notification.target === NotificationTarget.Slack) {
             await sendNotificationToSlack({
-                deployCommits,
-                branchConfig,
-                repoConfig,
+                ...params,
                 notification,
             });
         }

package/dist/notifications/slack.d.ts

@@ -5,4 +5,4 @@ export { type ChatPostMessageArguments } from '@slack/web-api';
  *
  * @category Internal
  */
-export declare function sendNotificationToSlack({ branchConfig, deployCommits: { deployedCommits, overwrittenCommits }, notification, repoConfig, }: Readonly<NotificationParams>): Promise<void>;
+export declare function sendNotificationToSlack({ branchConfig, deployResult: { deployCommits: { deployedCommits, overwrittenCommits }, branchStatus: { after, before }, }, notification, repoConfig, }: Readonly<NotificationParams>): Promise<void>;

package/dist/notifications/slack.js

@@ -1,4 +1,4 @@
-import { addPrefix } from '@augment-vir/common';
+import { addPrefix, capitalizeFirstLetter } from '@augment-vir/common';
 import { joinUrlPaths } from 'url-vir';
 function truncateString(value, truncateAt = 100) {
     if (value.length > truncateAt) {
@@ -22,7 +22,7 @@ function formatCommit(baseCommitUrl, commit) {
  *
  * @category Internal
  */
-export async function sendNotificationToSlack({ branchConfig, deployCommits: { deployedCommits, overwrittenCommits }, notification, repoConfig, }) {
+export async function sendNotificationToSlack({ branchConfig, deployResult: { deployCommits: { deployedCommits, overwrittenCommits }, branchStatus: { after, before }, }, notification, repoConfig, }) {
     const deployedCommitBullets = deployedCommits.map((commit) => formatCommit(repoConfig.commitBaseUrl, commit));
     const overwrittenCommitBullets = overwrittenCommits.map((commit) => formatCommit(repoConfig.commitBaseUrl, commit));
     const deployedCommitBulletsText = deployedCommitBullets
@@ -31,12 +31,25 @@ export async function sendNotificationToSlack({ branchConfig, deployCommits: { d
     const overwrittenCommitBulletsText = overwrittenCommitBullets.length
         ? overwrittenCommitBullets.map((bullet) => `- ${bullet}`).join('\n')
         : undefined;
+    const beforeText = repoConfig.commitBaseUrl
+        ? `<${joinUrlPaths(repoConfig.commitBaseUrl, before.hash)}|${before.hash.slice(0, 7)}>`
+        : before.hash;
+    const afterText = repoConfig.commitBaseUrl
+        ? `<${joinUrlPaths(repoConfig.commitBaseUrl, after.hash)}|${after.hash.slice(0, 7)}>`
+        : before.hash;
     const blocks = [
         {
             type: 'section',
             text: {
                 type: 'mrkdwn',
-                text: `*${branchConfig.deployName}* Deployed`,
+                text: `*${capitalizeFirstLetter(branchConfig.deployName)}* Pushed`,
+            },
+        },
+        {
+            type: 'context',
+            text: {
+                type: 'mrkdwn',
+                text: `${beforeText} -> ${afterText}`,
             },
         },
         {

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "deploy-vir",
-    "version": "0.1.1",
+    "version": "0.2.1",
     "description": "Deploy a branch to another branch with notifications.",
     "keywords": [
         "deploy",

package/src/cli/cli.ts

@@ -1,5 +1,6 @@
 import {assertWrap} from '@augment-vir/assert';
 import {extractErrorMessage, log} from '@augment-vir/common';
+import {resolve} from 'node:path';
 import simpleGit from 'simple-git';
 import {type DeployVirConfig} from '../config.js';
 import {getGitRemoteName, pushDeploy} from '../git.js';
@@ -16,7 +17,7 @@ export async function runDeployVirCli(args: ReadonlyArray<string>, cwd = process
     const repoName = assertWrap.isTruthy(args[1], 'Missing repo name.');
     const deployName = assertWrap.isTruthy(args[2], 'Missing deploy name.');
 
-    const config = (await import(configPath)).default;
+    const config = (await import(resolve(cwd, configPath))).default;
 
     await runDeployVir({cwd, deployName, repoName}, config);
 }
@@ -61,12 +62,12 @@ export async function runDeployVir(
         const remoteName = await getGitRemoteName(git, repoConfig);
         log.faint(`Remote: ${remoteName}`);
 
-        const deployCommits = await pushDeploy(git, branchConfig, remoteName);
+        const deployResult = await pushDeploy(git, branchConfig, remoteName);
 
         if (config.notifications?.length) {
             await sendNotifications(config.notifications, {
                 branchConfig,
-                deployCommits,
+                deployResult,
                 repoConfig,
             });
         }

package/src/git.ts

@@ -1,4 +1,4 @@
-import {assert, check} from '@augment-vir/assert';
+import {assert, assertWrap, check} from '@augment-vir/assert';
 import {extractErrorMessage, log, logColors} from '@augment-vir/common';
 import {askQuestion} from '@augment-vir/node';
 import {type DefaultLogFields, type ListLogLine, type SimpleGit} from 'simple-git';
@@ -61,6 +61,25 @@ export type DeployCommits = {
     deployedCommits: ReadonlyArray<Readonly<Commit>>;
     overwrittenCommits: ReadonlyArray<Readonly<Commit>>;
 };
+/**
+ * Before/after of the branch deployed to.
+ *
+ * @category Internal
+ */
+export type DeployBranchStatus = {
+    before: Readonly<Commit>;
+    after: Readonly<Commit>;
+};
+
+/**
+ * Output from {@link pushDeploy}.
+ *
+ * @category Internal
+ */
+export type DeployResult = {
+    deployCommits: DeployCommits;
+    branchStatus: DeployBranchStatus;
+};
 
 /**
  * Push the deploy via git.
@@ -71,7 +90,7 @@ export async function pushDeploy(
     git: Readonly<SimpleGit>,
     {deployName, fromBranch, toBranch}: Readonly<DeployVirBranchConfig>,
     remoteName: string,
-): Promise<DeployCommits> {
+): Promise<DeployResult> {
     assert.isTruthy(fromBranch, `Deploy '${deployName}' fromBranch cannot be empty.`);
     assert.isTruthy(toBranch, `Deploy '${deployName}' toBranch cannot be empty.`);
     assert.isTruthy(remoteName, 'Remote name cannot be empty.');
@@ -79,15 +98,36 @@ export async function pushDeploy(
     log.faint(`Pushing ${remoteName}/${fromBranch} to ${toBranch}`);
 
     await git.fetch(remoteName, fromBranch);
+    await git.fetch(remoteName, toBranch);
 
     const pushString = `${remoteName}/${fromBranch}:${toBranch}`;
 
+    // Get the current commit on the target branch before pushing
+    const beforeCommit = assertWrap.isDefined(
+        (
+            await git.log([
+                `${remoteName}/${toBranch}`,
+                '-1',
+            ])
+        ).latest,
+        `Failed to get current commit for ${remoteName}/${toBranch}`,
+    );
+
+    const afterCommit = assertWrap.isDefined(
+        (
+            await git.log([
+                `${remoteName}/${fromBranch}`,
+                '-1',
+            ])
+        ).latest,
+        `Failed to get current commit for ${remoteName}/${fromBranch}`,
+    );
+
     /** Get commits that are on {@link toBranch} but not on {@link fromBranch}. */
     const commitsAhead = (
-        await git.log({
-            from: `${remoteName}/${toBranch}`,
-            to: `${remoteName}/${fromBranch}`,
-        })
+        await git.log([
+            '${remoteName}/${toBranch}..${remoteName}/${fromBranch}',
+        ])
     ).all;
 
     if (!commitsAhead.length) {
@@ -98,23 +138,30 @@ export async function pushDeploy(
         await git.push(remoteName, pushString);
 
         return {
-            deployedCommits: commitsAhead,
-            overwrittenCommits: [],
+            deployCommits: {
+                deployedCommits: commitsAhead,
+                overwrittenCommits: [],
+            },
+            branchStatus: {
+                before: beforeCommit,
+                after: afterCommit,
+            },
         };
     } catch (error) {
         log.error(`Push failed: ${extractErrorMessage(error)}`);
 
         /** Get commits that are on {@link toBranch} but not on {@link fromBranch}. */
-        const commitsBehind = await git.log({
-            from: `${remoteName}/${fromBranch}`,
-            to: `${remoteName}/${toBranch}`,
-        });
+        const commitsBehind = (
+            await git.log([
+                '${remoteName}/${fromBranch}..${remoteName}/${toBranch}',
+            ])
+        ).all;
 
-        if (commitsBehind.total > 0) {
+        if (commitsBehind.length > 0) {
             log.info(
-                `\nThe following ${commitsBehind.total} commit${commitsBehind.total === 1 ? '' : 's'} are on ${logColors.bold}${toBranch}${logColors.reset} but not on ${logColors.bold}${fromBranch}${logColors.reset}:`,
+                `\nThe following ${commitsBehind.length} commit${commitsBehind.length === 1 ? '' : 's'} are on ${logColors.bold}${toBranch}${logColors.reset} but not on ${logColors.bold}${fromBranch}${logColors.reset}:`,
             );
-            commitsBehind.all.forEach((commit, index) => {
+            commitsBehind.forEach((commit, index) => {
                 log.faint(
                     `    ${index + 1}. ${commit.hash.slice(0, 7)} (${commit.author_name}) - ${commit.message}`,
                 );
@@ -135,8 +182,14 @@ export async function pushDeploy(
         }
 
         return {
-            deployedCommits: commitsAhead,
-            overwrittenCommits: commitsBehind.all,
+            deployCommits: {
+                deployedCommits: commitsAhead,
+                overwrittenCommits: commitsBehind,
+            },
+            branchStatus: {
+                before: beforeCommit,
+                after: afterCommit,
+            },
         };
     }
 }

package/src/notifications/notification-params.ts

@@ -4,7 +4,7 @@ import {
     type NotificationConfig,
     type NotificationTarget,
 } from '../config.js';
-import {type DeployCommits} from '../git.js';
+import {type DeployResult} from '../git.js';
 
 /**
  * Params for sending a notification.
@@ -12,7 +12,7 @@ import {type DeployCommits} from '../git.js';
  * @category Internal
  */
 export type NotificationParams<Target extends NotificationTarget = NotificationTarget> = {
-    deployCommits: Readonly<DeployCommits>;
+    deployResult: Readonly<DeployResult>;
     branchConfig: Readonly<DeployVirBranchConfig>;
     repoConfig: Readonly<Pick<DeployVirRepoConfig, 'commitBaseUrl'>>;
     notification: Readonly<Extract<NotificationConfig, {target: Target}>>;

package/src/notifications/send-notifications.ts

@@ -10,16 +10,14 @@ import {sendNotificationToSlack} from './slack.js';
  */
 export async function sendNotifications(
     notifications: ReadonlyArray<Readonly<NotificationConfig>>,
-    {branchConfig, deployCommits, repoConfig}: Readonly<Omit<NotificationParams, 'notification'>>,
+    params: Readonly<Omit<NotificationParams, 'notification'>>,
 ) {
     await Promise.all(
         notifications.map(async (notification) => {
             // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
             if (notification.target === NotificationTarget.Slack) {
                 await sendNotificationToSlack({
-                    deployCommits,
-                    branchConfig,
-                    repoConfig,
+                    ...params,
                     notification,
                 });
             } else {

package/src/notifications/slack.ts

@@ -1,4 +1,4 @@
-import {addPrefix} from '@augment-vir/common';
+import {addPrefix, capitalizeFirstLetter} from '@augment-vir/common';
 import {type ChatPostMessageArguments} from '@slack/web-api';
 import {joinUrlPaths} from 'url-vir';
 import {type SlackNotificationConfig} from '../config.js';
@@ -32,7 +32,10 @@ function formatCommit(baseCommitUrl: string | undefined, commit: Readonly<Commit
  */
 export async function sendNotificationToSlack({
     branchConfig,
-    deployCommits: {deployedCommits, overwrittenCommits},
+    deployResult: {
+        deployCommits: {deployedCommits, overwrittenCommits},
+        branchStatus: {after, before},
+    },
     notification,
     repoConfig,
 }: Readonly<NotificationParams>) {
@@ -51,12 +54,26 @@ export async function sendNotificationToSlack({
         ? overwrittenCommitBullets.map((bullet) => `- ${bullet}`).join('\n')
         : undefined;
 
+    const beforeText = repoConfig.commitBaseUrl
+        ? `<${joinUrlPaths(repoConfig.commitBaseUrl, before.hash)}|${before.hash.slice(0, 7)}>`
+        : before.hash;
+    const afterText = repoConfig.commitBaseUrl
+        ? `<${joinUrlPaths(repoConfig.commitBaseUrl, after.hash)}|${after.hash.slice(0, 7)}>`
+        : before.hash;
+
     const blocks: any[] = [
         {
             type: 'section',
             text: {
                 type: 'mrkdwn',
-                text: `*${branchConfig.deployName}* Deployed`,
+                text: `*${capitalizeFirstLetter(branchConfig.deployName)}* Pushed`,
+            },
+        },
+        {
+            type: 'context',
+            text: {
+                type: 'mrkdwn',
+                text: `${beforeText} -> ${afterText}`,
             },
         },
         {