deploy-vir 0.0.0 → 0.0.2

package/LICENSE-CC0

@@ -0,0 +1,121 @@
+CC0 1.0 Universal
+
+Creative Commons Legal Code
+
+    CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE
+    LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN
+    ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS
+    INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES
+    REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS
+    PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM
+    THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED
+    HEREUNDER.
+
+Statement of Purpose
+
+The laws of most jurisdictions throughout the world automatically confer
+exclusive Copyright and Related Rights (defined below) upon the creator
+and subsequent owner(s) (each and all, an "owner") of an original work of
+authorship and/or a database (each, a "Work").
+
+Certain owners wish to permanently relinquish those rights to a Work for
+the purpose of contributing to a commons of creative, cultural and
+scientific works ("Commons") that the public can reliably and without fear
+of later claims of infringement build upon, modify, incorporate in other
+works, reuse and redistribute as freely as possible in any form whatsoever
+and for any purposes, including without limitation commercial purposes.
+These owners may contribute to the Commons to promote the ideal of a free
+culture and the further production of creative, cultural and scientific
+works, or to gain reputation or greater distribution for their Work in
+part through the use and efforts of others.
+
+For these and/or other purposes and motivations, and without any
+expectation of additional consideration or compensation, the person
+associating CC0 with a Work (the "Affirmer"), to the extent that he or she
+is an owner of Copyright and Related Rights in the Work, voluntarily
+elects to apply CC0 to the Work and publicly distribute the Work under its
+terms, with knowledge of his or her Copyright and Related Rights in the
+Work and the meaning and intended legal effect of CC0 on those rights.
+
+1. Copyright and Related Rights. A Work made available under CC0 may be
+protected by copyright and related or neighboring rights ("Copyright and
+Related Rights"). Copyright and Related Rights include, but are not
+limited to, the following:
+
+  i. the right to reproduce, adapt, distribute, perform, display,
+     communicate, and translate a Work;
+ ii. moral rights retained by the original author(s) and/or performer(s);
+iii. publicity and privacy rights pertaining to a person's image or
+     likeness depicted in a Work;
+ iv. rights protecting against unfair competition in regards to a Work,
+     subject to the limitations in paragraph 4(a), below;
+  v. rights protecting the extraction, dissemination, use and reuse of data
+     in a Work;
+ vi. database rights (such as those arising under Directive 96/9/EC of the
+     European Parliament and of the Council of 11 March 1996 on the legal
+     protection of databases, and under any national implementation
+     thereof, including any amended or successor version of such
+     directive); and
+vii. other similar, equivalent or corresponding rights throughout the
+     world based on applicable law or treaty, and any national
+     implementations thereof.
+
+2. Waiver. To the greatest extent permitted by, but not in contravention
+of, applicable law, Affirmer hereby overtly, fully, permanently,
+irrevocably and unconditionally waives, abandons, and surrenders all of
+Affirmer's Copyright and Related Rights and associated claims and causes
+of action, whether now known or unknown (including existing as well as
+future claims and causes of action), in the Work (i) in all territories
+worldwide, (ii) for the maximum duration provided by applicable law or
+treaty (including future time extensions), (iii) in any current or future
+medium and for any number of copies, and (iv) for any purpose whatsoever,
+including without limitation commercial, advertising or promotional
+purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each
+member of the public at large and to the detriment of Affirmer's heirs and
+successors, fully intending that such Waiver shall not be subject to
+revocation, rescission, cancellation, termination, or any other legal or
+equitable action to disrupt the quiet enjoyment of the Work by the public
+as contemplated by Affirmer's express Statement of Purpose.
+
+3. Public License Fallback. Should any part of the Waiver for any reason
+be judged legally invalid or ineffective under applicable law, then the
+Waiver shall be preserved to the maximum extent permitted taking into
+account Affirmer's express Statement of Purpose. In addition, to the
+extent the Waiver is so judged Affirmer hereby grants to each affected
+person a royalty-free, non transferable, non sublicensable, non exclusive,
+irrevocable and unconditional license to exercise Affirmer's Copyright and
+Related Rights in the Work (i) in all territories worldwide, (ii) for the
+maximum duration provided by applicable law or treaty (including future
+time extensions), (iii) in any current or future medium and for any number
+of copies, and (iv) for any purpose whatsoever, including without
+limitation commercial, advertising or promotional purposes (the
+"License"). The License shall be deemed effective as of the date CC0 was
+applied by Affirmer to the Work. Should any part of the License for any
+reason be judged legally invalid or ineffective under applicable law, such
+partial invalidity or ineffectiveness shall not invalidate the remainder
+of the License, and in such case Affirmer hereby affirms that he or she
+will not (i) exercise any of his or her remaining Copyright and Related
+Rights in the Work or (ii) assert any associated claims and causes of
+action with respect to the Work, in either case contrary to Affirmer's
+express Statement of Purpose.
+
+4. Limitations and Disclaimers.
+
+ a. No trademark or patent rights held by Affirmer are waived, abandoned,
+    surrendered, licensed or otherwise affected by this document.
+ b. Affirmer offers the Work as-is and makes no representations or
+    warranties of any kind concerning the Work, express, implied,
+    statutory or otherwise, including without limitation warranties of
+    title, merchantability, fitness for a particular purpose, non
+    infringement, or the absence of latent or other defects, accuracy, or
+    the present or absence of errors, whether or not discoverable, all to
+    the greatest extent permissible under applicable law.
+ c. Affirmer disclaims responsibility for clearing rights of other persons
+    that may apply to the Work or any use thereof, including without
+    limitation any person's Copyright and Related Rights in the Work.
+    Further, Affirmer disclaims responsibility for obtaining any necessary
+    consents, permissions or other rights required for any use of the
+    Work.
+ d. Affirmer understands and acknowledges that Creative Commons is not a
+    party to this document and has no duty or obligation with respect to
+    this CC0 or use of the Work.

package/LICENSE-MIT

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 electrovir
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,56 @@
+# deploy-vir
+
+Deploy from branch to branch via git.
+
+## Install
+
+```sh
+npm i -D deploy-vir
+```
+
+## Setup
+
+Add a TypeScript or JavaScript config file somewhere in your repo. Its default export should be your config:
+
+<!-- example-link: src/readme-examples/config.example.ts -->
+
+```TypeScript
+import {defineDeployVirConfig, NotificationTarget} from 'deploy-vir';
+
+export default defineDeployVirConfig({
+    repos: [
+        {
+            /** This does not need to match the actual repo name. */
+            name: 'whatever',
+            girUrl: 'git@github.com:electrovir/deploy-vir.git',
+            deploys: [
+                {
+                    deployName: 'staging',
+                    fromBranch: 'dev',
+                    toBranch: 'staging',
+                },
+                {
+                    deployName: 'prod',
+                    fromBranch: 'staging',
+                    toBranch: 'prod',
+                },
+            ],
+        },
+    ],
+    notifications: [
+        {
+            target: NotificationTarget.Slack,
+            webhookUrl: 'https://hooks.slack.com/services/X/X/X',
+            channelName: '#deploys',
+        },
+    ],
+});
+```
+
+## Running
+
+Then just run the CLI:
+
+```sh
+npx deploy-vir <path-to-config> <repo-name-to-deploy> <deploy-name-to-deploy>
+```

package/bin.js

@@ -0,0 +1,8 @@
+#!/usr/bin/env node
+
+import {runCliScript} from '@augment-vir/node/dist/index.js';
+import {join} from 'node:path';
+
+const cliPath = join(import.meta.dirname, 'src', 'cli.script.ts');
+
+await runCliScript(cliPath, import.meta.filename, 'deploy-vir');

package/dist/cli/cli.d.ts

@@ -0,0 +1,25 @@
+import { type DeployVirConfig } from '../config.js';
+/**
+ * Run the deploy-vir CLI.
+ *
+ * @category Internal
+ */
+export declare function runDeployVirCli(args: ReadonlyArray<string>, cwd?: string): Promise<void>;
+/**
+ * Args for {@link runDeployVir}.
+ *
+ * @category Internal
+ */
+export type DeployVirArgs = {
+    /** This must match a repo name in your config. */
+    repoName: string;
+    /** This much match a deploy name in your config. */
+    deployName: string;
+    cwd: string;
+};
+/**
+ * Run a deploy.
+ *
+ * @category Main
+ */
+export declare function runDeployVir(args: Readonly<DeployVirArgs>, config: Readonly<DeployVirConfig>): Promise<void>;

package/dist/cli/cli.js

@@ -0,0 +1,48 @@
+import { assertWrap } from '@augment-vir/assert';
+import { extractErrorMessage, log } from '@augment-vir/common';
+import simpleGit from 'simple-git';
+import { getGitRemoteName, pushDeploy } from '../git.js';
+import { KnownError } from '../known.error.js';
+import { sendNotifications } from '../notifications/send-notifications.js';
+/**
+ * Run the deploy-vir CLI.
+ *
+ * @category Internal
+ */
+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;
+    await runDeployVir({ cwd, deployName, repoName }, config);
+}
+/**
+ * Run a deploy.
+ *
+ * @category Main
+ */
+export async function runDeployVir(args, config) {
+    try {
+        const git = simpleGit(args.cwd);
+        const repoConfig = assertWrap.isDefined(config.repos.find((repo) => repo.name === args.repoName, `Failed to find a repo config by name '${args.repoName}'`));
+        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);
+        const deployCommits = await pushDeploy(git, branchConfig, remoteName);
+        if (config.notifications?.length) {
+            await sendNotifications(config.notifications, {
+                branchConfig,
+                deployCommits,
+                repoConfig,
+            });
+        }
+    }
+    catch (error) {
+        if (error instanceof KnownError) {
+            /** If its a known error, don't log the whole stack trace. */
+            log.error(extractErrorMessage(error));
+        }
+        else {
+            log.error(error);
+        }
+    }
+}

package/dist/cli/cli.script.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/cli/cli.script.js

@@ -0,0 +1,2 @@
+import { runDeployVirCli } from './cli.js';
+await runDeployVirCli(process.argv, process.cwd());

package/dist/config.d.ts

@@ -0,0 +1,101 @@
+/**
+ * The full deploy-vir config object.
+ *
+ * @category Config
+ */
+export type DeployVirConfig = {
+    repos: DeployVirRepoConfig[];
+    notifications?: NotificationConfig[] | undefined;
+};
+/**
+ * All available targets for sending notifications to.
+ *
+ * @category Internal
+ */
+export declare enum NotificationTarget {
+    Slack = "slack"
+}
+/**
+ * Notification config for Slack.
+ *
+ * @category Internal
+ */
+export type SlackNotificationConfig = {
+    target: NotificationTarget;
+    /**
+     * Find or create this by going to:
+     *
+     * Apps and workflows > Custom Integrations > Incoming WebHooks
+     */
+    webhookUrl: string;
+    /**
+     * An emoji string for the Webhook's message. If not provided, the Webhook integration's avatar
+     * that you set will be used.
+     */
+    avatarEmoji?: string | undefined;
+    /**
+     * A username for the Webhook's message. If not provided, the Webhook integration's avatar that
+     * you set will be used.
+     */
+    username?: string | undefined;
+    /** A channel for the Webhook's message. If not provided, the Webhook integration */
+    channelName: string | undefined;
+    /**
+     * By default the notification will list out all commits that are getting deployed. This will
+     * turn that off.
+     */
+    hideAllCommits?: boolean | undefined;
+};
+/**
+ * Config for a notification when a deploy runs.
+ *
+ * @category Config
+ */
+export type NotificationConfig = SlackNotificationConfig;
+/**
+ * A repo config for deploying.
+ *
+ * @category Config
+ */
+export type DeployVirRepoConfig = {
+    /**
+     * Does not need to match the actual repo name in GitHub, it can just be whatever name you want
+     * to call it for deploy-vir.
+     */
+    name: string;
+    /**
+     * A git URL to the repo.
+     *
+     * @example
+     *
+     * - 'git@github.com:electrovir/deploy-vir.git'
+     * - 'https://github.com/electrovir/deploy-vir.git'
+     */
+    girUrl: string;
+    /**
+     * A url to the base commit path for links. The commit hash will be appended to this for links
+     * in notifications. If this is omitted, there simply won't be any links.
+     *
+     * @example
+     *
+     * - 'https://github.com/electrovir/deploy-vir/commit'
+     */
+    commitBaseUrl?: string | undefined;
+    deploys: DeployVirBranchConfig[];
+};
+/**
+ * A deploy configuration.
+ *
+ * @category Config
+ */
+export type DeployVirBranchConfig = {
+    deployName: string;
+    fromBranch: string;
+    toBranch: string;
+};
+/**
+ * Define a type safe deploy-vir config.
+ *
+ * @category Internal
+ */
+export declare function defineDeployVirConfig(config: Readonly<DeployVirConfig>): Readonly<DeployVirConfig>;

package/dist/config.js

@@ -0,0 +1,17 @@
+/**
+ * All available targets for sending notifications to.
+ *
+ * @category Internal
+ */
+export var NotificationTarget;
+(function (NotificationTarget) {
+    NotificationTarget["Slack"] = "slack";
+})(NotificationTarget || (NotificationTarget = {}));
+/**
+ * Define a type safe deploy-vir config.
+ *
+ * @category Internal
+ */
+export function defineDeployVirConfig(config) {
+    return config;
+}

package/dist/git.d.ts

@@ -0,0 +1,29 @@
+import { type DefaultLogFields, type ListLogLine, type SimpleGit } from 'simple-git';
+import { type DeployVirBranchConfig, type DeployVirRepoConfig } from './config.js';
+/**
+ * Find the git remote's name, or create a new one.
+ *
+ * @category Internal
+ */
+export declare function getGitRemoteName(git: Readonly<SimpleGit>, repoConfig: Readonly<Pick<DeployVirRepoConfig, 'name' | 'girUrl'>>): Promise<string>;
+/**
+ * A git commit.
+ *
+ * @category Internal
+ */
+export type Commit = DefaultLogFields & ListLogLine;
+/**
+ * All commits involved in a deploy.
+ *
+ * @category Internal
+ */
+export type DeployCommits = {
+    deployedCommits: ReadonlyArray<Readonly<Commit>>;
+    overwrittenCommits: ReadonlyArray<Readonly<Commit>>;
+};
+/**
+ * Push the deploy via git.
+ *
+ * @category Internal
+ */
+export declare function pushDeploy(git: Readonly<SimpleGit>, { deployName, fromBranch, toBranch }: Readonly<DeployVirBranchConfig>, remoteName: string): Promise<DeployCommits>;

package/dist/git.js

@@ -0,0 +1,80 @@
+import { assert, 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';
+/**
+ * Find the git remote's name, or create a new one.
+ *
+ * @category Internal
+ */
+export async function getGitRemoteName(git, repoConfig) {
+    assert.isTruthy(repoConfig.name, 'Repo config name cannot be empty.');
+    assert.isTruthy(repoConfig.girUrl, 'Repo git URL cannot be empty.');
+    const remotes = await git.getRemotes(true);
+    const remoteMatchByUrl = remotes.find((remote) => remote.refs.fetch === repoConfig.girUrl || remote.refs.push === repoConfig.girUrl);
+    if (remoteMatchByUrl) {
+        return remoteMatchByUrl.name;
+    }
+    const remoteMatchByNameCount = remotes.reduce((count, remote) => count + (remote.name === repoConfig.name ? 1 : 0), 0);
+    const newRemoteName = [
+        repoConfig.name,
+        remoteMatchByNameCount,
+    ]
+        .filter(check.isTruthy)
+        .join('-');
+    await git.addRemote(newRemoteName, repoConfig.girUrl);
+    return newRemoteName;
+}
+/**
+ * Push the deploy via git.
+ *
+ * @category Internal
+ */
+export async function pushDeploy(git, { deployName, fromBranch, toBranch }, remoteName) {
+    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.');
+    await git.fetch(remoteName, fromBranch);
+    const pushString = `${remoteName}/${fromBranch}:${toBranch}`;
+    /** Get commits that are on {@link toBranch} but not on {@link fromBranch}. */
+    const commitsAhead = (await git.log({
+        from: `${remoteName}/${toBranch}`,
+        to: `${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: [],
+        };
+    }
+    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) => {
+                log.faint(`    ${index + 1}. ${commit.hash.slice(0, 7)} (${commit.author_name}) - ${commit.message}`);
+            });
+        }
+        const shouldForcePush = await askQuestion(`\nDo you want to force push ${logColors.bold}${fromBranch}${logColors.reset} to ${logColors.bold}${toBranch}${logColors.reset}?\n\n${logColors.warning}This will overwrite the commits listed above.${logColors.reset} (y/N): `);
+        if (shouldForcePush.toLowerCase() === 'y' || shouldForcePush.toLowerCase() === 'yes') {
+            await git.push(remoteName, pushString, ['--force']);
+            log.warning(`Force pushed ${logColors.bold}${fromBranch}${logColors.reset} to ${logColors.bold}${toBranch}${logColors.reset}.`);
+        }
+        else {
+            throw new KnownError(`Deploy aborted.`);
+        }
+        return {
+            deployedCommits: commitsAhead,
+            overwrittenCommits: commitsBehind.all,
+        };
+    }
+}

package/dist/index.d.ts

@@ -0,0 +1,7 @@
+export * from './cli/cli.js';
+export * from './config.js';
+export * from './git.js';
+export * from './known.error.js';
+export * from './notifications/notification-params.js';
+export * from './notifications/send-notifications.js';
+export * from './notifications/slack.js';

package/dist/index.js

@@ -0,0 +1,7 @@
+export * from './cli/cli.js';
+export * from './config.js';
+export * from './git.js';
+export * from './known.error.js';
+export * from './notifications/notification-params.js';
+export * from './notifications/send-notifications.js';
+export * from './notifications/slack.js';

package/dist/known.error.d.ts

@@ -0,0 +1,8 @@
+/**
+ * A known error that won't get its full stack trace logged.
+ *
+ * @category Internal
+ */
+export declare class KnownError extends Error {
+    readonly name = "KnownError";
+}

package/dist/known.error.js

@@ -0,0 +1,8 @@
+/**
+ * A known error that won't get its full stack trace logged.
+ *
+ * @category Internal
+ */
+export class KnownError extends Error {
+    name = 'KnownError';
+}

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

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

package/dist/notifications/notification-params.js

@@ -0,0 +1 @@
+export {};

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

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

package/dist/notifications/send-notifications.js

@@ -0,0 +1,24 @@
+import { NotificationTarget } from '../config.js';
+import { KnownError } from '../known.error.js';
+import { sendNotificationToSlack } from './slack.js';
+/**
+ * Send all configured notifications.
+ *
+ * @category Internal
+ */
+export async function sendNotifications(notifications, { branchConfig, deployCommits, repoConfig }) {
+    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,
+                notification,
+            });
+        }
+        else {
+            throw new KnownError(`Unexpected notification target: '${String(notification.target)}'`);
+        }
+    }));
+}

package/dist/notifications/slack.d.ts

@@ -0,0 +1,8 @@
+import { type NotificationParams } from './notification-params.js';
+export { type ChatPostMessageArguments } from '@slack/web-api';
+/**
+ * Send a notification to Slack.
+ *
+ * @category Internal
+ */
+export declare function sendNotificationToSlack({ branchConfig, deployCommits: { deployedCommits, overwrittenCommits }, notification, repoConfig, }: Readonly<NotificationParams>): Promise<void>;

package/dist/notifications/slack.js

@@ -0,0 +1,95 @@
+import { addPrefix } from '@augment-vir/common';
+import { joinUrlPaths } from 'url-vir';
+function truncateString(value, truncateAt = 100) {
+    if (value.length > truncateAt) {
+        return `${value.slice(0, Math.max(0, truncateAt))}...`;
+    }
+    else {
+        return value;
+    }
+}
+function formatCommit(baseCommitUrl, commit) {
+    const commitLine = `${commit.hash.slice(0, 7)} (${commit.author_name}) - ${truncateString(commit.message)}`;
+    if (baseCommitUrl) {
+        return `<${joinUrlPaths(baseCommitUrl, commit.hash)}|${commitLine}>`;
+    }
+    else {
+        return commitLine;
+    }
+}
+/**
+ * Send a notification to Slack.
+ *
+ * @category Internal
+ */
+export async function sendNotificationToSlack({ branchConfig, deployCommits: { deployedCommits, overwrittenCommits }, notification, repoConfig, }) {
+    const deployedCommitBullets = deployedCommits.map((commit) => formatCommit(repoConfig.commitBaseUrl, commit));
+    const overwrittenCommitBullets = overwrittenCommits.map((commit) => formatCommit(repoConfig.commitBaseUrl, commit));
+    const deployedCommitBulletsText = deployedCommitBullets
+        .map((bullet) => `• ${bullet}`)
+        .join('\n');
+    const overwrittenCommitBulletsText = overwrittenCommitBullets.length
+        ? overwrittenCommitBullets.map((bullet) => `• ${bullet}`).join('\n')
+        : undefined;
+    const blocks = [
+        {
+            type: 'section',
+            text: {
+                type: 'mrkdwn',
+                text: `*${branchConfig.deployName}* Deployed`,
+            },
+        },
+        {
+            type: 'section',
+            text: {
+                type: 'mrkdwn',
+                text: `\n*Deployed Commits*\n${deployedCommitBulletsText}`,
+            },
+        },
+        ...(overwrittenCommitBulletsText
+            ? [
+                {
+                    type: 'section',
+                    text: {
+                        type: 'mrkdwn',
+                        text: `\n*Overwritten Commits*\n${overwrittenCommitBulletsText}`,
+                    },
+                },
+            ]
+            : []),
+    ];
+    await sendSlackMessage(notification, {
+        attachments: [],
+        channel: addPrefix({ value: notification.channelName, prefix: '#' }),
+        blocks,
+    });
+}
+async function sendSlackMessage(slackConfig, body) {
+    try {
+        const response = await fetch(slackConfig.webhookUrl, {
+            method: 'POST',
+            headers: {
+                'Content-Type': 'application/json',
+            },
+            body: JSON.stringify({
+                ...body,
+                ...(slackConfig.avatarEmoji
+                    ? {
+                        icon_emoji: slackConfig.avatarEmoji,
+                    }
+                    : {}),
+                ...(slackConfig.username
+                    ? {
+                        username: slackConfig.username,
+                    }
+                    : {}),
+            }),
+        });
+        if (!response.ok) {
+            throw new Error(`Failed to send Slack webhook: ${response.status}`);
+        }
+    }
+    catch (error) {
+        console.error('Error sending Slack message:', error);
+    }
+}

package/package.json

@@ -1,13 +1,90 @@
 {
-  "name": "deploy-vir",
-  "version": "0.0.0",
-  "description": "",
-  "main": "index.js",
-  "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
-  },
-  "keywords": [],
-  "author": "",
-  "license": "MIT",
-  "type": "commonjs"
+    "name": "deploy-vir",
+    "version": "0.0.2",
+    "description": "Deploy a branch to another branch with notifications.",
+    "keywords": [
+        "deploy",
+        "devops",
+        "pipeline"
+    ],
+    "homepage": "https://github.com/electrovir/deploy-vir",
+    "bugs": {
+        "url": "https://github.com/electrovir/deploy-vir/issues"
+    },
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/electrovir/deploy-vir.git"
+    },
+    "license": "(MIT or CC0 1.0)",
+    "author": {
+        "name": "electrovir",
+        "url": "https://github.com/electrovir"
+    },
+    "sideEffects": false,
+    "type": "module",
+    "main": "dist/index.js",
+    "module": "dist/index.js",
+    "types": "dist/index.d.ts",
+    "bin": "bin.js",
+    "scripts": {
+        "compile": "virmator compile",
+        "docs": "virmator docs",
+        "format": "virmator format",
+        "lint": "virmator lint fix",
+        "publish": "virmator publish npm run test:all",
+        "test:all": "npm run compile && concurrently --colors --kill-others-on-fail -c auto --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:deps": "virmator deps check",
+        "test:docs": "virmator docs check",
+        "test:format": "virmator format check",
+        "test:lint": "virmator lint",
+        "test:spelling": "virmator spellcheck",
+        "test:update": "npm run test update"
+    },
+    "dependencies": {
+        "@augment-vir/assert": "^31.28.0",
+        "@augment-vir/common": "^31.28.0",
+        "@augment-vir/node": "^31.28.0",
+        "@slack/web-api": "^7.9.3",
+        "simple-git": "^3.28.0",
+        "tsx": "^4.20.3",
+        "url-vir": "^2.1.3"
+    },
+    "devDependencies": {
+        "@eslint/eslintrc": "^3.3.1",
+        "@eslint/js": "^9.32.0",
+        "@stylistic/eslint-plugin": "^5.2.2",
+        "@stylistic/eslint-plugin-ts": "^4.4.1",
+        "@types/node": "^24.1.0",
+        "@typescript-eslint/eslint-plugin": "^8.38.0",
+        "cspell": "^9.2.0",
+        "dependency-cruiser": "^17.0.0",
+        "esbuild": "^0.25.8",
+        "eslint": "^9.32.0",
+        "eslint-config-prettier": "^10.1.8",
+        "eslint-plugin-jsdoc": "^52.0.1",
+        "eslint-plugin-monorepo-cop": "^1.0.2",
+        "eslint-plugin-playwright": "^2.2.1",
+        "eslint-plugin-prettier": "^5.5.3",
+        "eslint-plugin-require-extensions": "^0.1.3",
+        "eslint-plugin-sonarjs": "^3.0.4",
+        "eslint-plugin-unicorn": "^57.0.0",
+        "istanbul-smart-text-reporter": "^1.1.5",
+        "markdown-code-example-inserter": "^3.0.3",
+        "npm-check-updates": "^18.0.2",
+        "prettier": "^3.3.3",
+        "prettier-plugin-interpolated-html-tags": "^2.0.1",
+        "prettier-plugin-jsdoc": "^1.3.3",
+        "prettier-plugin-multiline-arrays": "^4.0.3",
+        "prettier-plugin-organize-imports": "^4.2.0",
+        "prettier-plugin-packagejson": "^2.5.19",
+        "prettier-plugin-sort-json": "^4.1.1",
+        "prettier-plugin-toml": "^2.0.6",
+        "typedoc": "^0.28.8",
+        "typescript": "^5.8.3",
+        "typescript-eslint": "^8.38.0",
+        "virmator": "^13.15.6"
+    },
+    "engines": {
+        "node": ">=22"
+    }
 }