deploy-vir 0.0.3 → 0.1.1

package/README.md

@@ -22,7 +22,7 @@ export default defineDeployVirConfig({
         {
             /** This does not need to match the actual repo name. */
             name: 'whatever',
-            girUrl: 'git@github.com:electrovir/deploy-vir.git',
+            gitUrl: 'git@github.com:electrovir/deploy-vir.git',
             deploys: [
                 {
                     deployName: 'staging',

package/dist/cli/cli.js

@@ -27,6 +27,7 @@ export async function runDeployVir(args, config) {
         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);
+        log.faint(`Remote: ${remoteName}`);
         const deployCommits = await pushDeploy(git, branchConfig, remoteName);
         if (config.notifications?.length) {
             await sendNotifications(config.notifications, {

package/dist/cli/cli.script.js

@@ -1,2 +1,7 @@
+import { extractRelevantArgs } from '@augment-vir/node';
 import { runDeployVirCli } from './cli.js';
-await runDeployVirCli(process.argv, process.cwd());
+await runDeployVirCli(extractRelevantArgs({
+    binName: 'deploy-vir',
+    fileName: import.meta.filename,
+    rawArgs: process.argv,
+}), process.cwd());

package/dist/config.d.ts

@@ -71,7 +71,7 @@ export type DeployVirRepoConfig = {
      * - 'git@github.com:electrovir/deploy-vir.git'
      * - 'https://github.com/electrovir/deploy-vir.git'
      */
-    girUrl: string;
+    gitUrl: 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.

package/dist/git.d.ts

@@ -5,7 +5,7 @@ import { type DeployVirBranchConfig, type DeployVirRepoConfig } from './config.j
  *
  * @category Internal
  */
-export declare function getGitRemoteName(git: Readonly<SimpleGit>, repoConfig: Readonly<Pick<DeployVirRepoConfig, 'name' | 'girUrl'>>): Promise<string>;
+export declare function getGitRemoteName(git: Readonly<SimpleGit>, repoConfig: Readonly<Pick<DeployVirRepoConfig, 'name' | 'gitUrl'>>): Promise<string>;
 /**
  * A git commit.
  *

package/dist/git.js

@@ -9,9 +9,9 @@ import { KnownError } from './known.error.js';
  */
 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.');
+    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.girUrl || remote.refs.push === repoConfig.girUrl);
+    const remoteMatchByUrl = remotes.find((remote) => remote.refs.fetch === repoConfig.gitUrl || remote.refs.push === repoConfig.gitUrl);
     if (remoteMatchByUrl) {
         return remoteMatchByUrl.name;
     }
@@ -22,7 +22,7 @@ export async function getGitRemoteName(git, repoConfig) {
     ]
         .filter(check.isTruthy)
         .join('-');
-    await git.addRemote(newRemoteName, repoConfig.girUrl);
+    await git.addRemote(newRemoteName, repoConfig.gitUrl);
     return newRemoteName;
 }
 /**
@@ -34,6 +34,7 @@ export async function pushDeploy(git, { deployName, fromBranch, toBranch }, remo
     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.');
+    log.faint(`Pushing ${remoteName}/${fromBranch} to ${toBranch}`);
     await git.fetch(remoteName, fromBranch);
     const pushString = `${remoteName}/${fromBranch}:${toBranch}`;
     /** Get commits that are on {@link toBranch} but not on {@link fromBranch}. */

package/dist/notifications/slack.js

@@ -26,10 +26,10 @@ export async function sendNotificationToSlack({ branchConfig, deployCommits: { d
     const deployedCommitBullets = deployedCommits.map((commit) => formatCommit(repoConfig.commitBaseUrl, commit));
     const overwrittenCommitBullets = overwrittenCommits.map((commit) => formatCommit(repoConfig.commitBaseUrl, commit));
     const deployedCommitBulletsText = deployedCommitBullets
-        .map((bullet) => `• ${bullet}`)
+        .map((bullet) => `- ${bullet}`)
         .join('\n');
     const overwrittenCommitBulletsText = overwrittenCommitBullets.length
-        ? overwrittenCommitBullets.map((bullet) => `• ${bullet}`).join('\n')
+        ? overwrittenCommitBullets.map((bullet) => `- ${bullet}`).join('\n')
         : undefined;
     const blocks = [
         {

package/package.json

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

package/src/cli/cli.script.ts

@@ -1,3 +1,11 @@
+import {extractRelevantArgs} from '@augment-vir/node';
 import {runDeployVirCli} from './cli.js';
 
-await runDeployVirCli(process.argv, process.cwd());
+await runDeployVirCli(
+    extractRelevantArgs({
+        binName: 'deploy-vir',
+        fileName: import.meta.filename,
+        rawArgs: process.argv,
+    }),
+    process.cwd(),
+);

package/src/cli/cli.ts

@@ -59,6 +59,7 @@ export async function runDeployVir(
             ),
         );
         const remoteName = await getGitRemoteName(git, repoConfig);
+        log.faint(`Remote: ${remoteName}`);
 
         const deployCommits = await pushDeploy(git, branchConfig, remoteName);
 

package/src/config.ts

@@ -76,7 +76,7 @@ export type DeployVirRepoConfig = {
      * - 'git@github.com:electrovir/deploy-vir.git'
      * - 'https://github.com/electrovir/deploy-vir.git'
      */
-    girUrl: string;
+    gitUrl: 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.

package/src/git.ts

@@ -12,16 +12,16 @@ import {KnownError} from './known.error.js';
  */
 export async function getGitRemoteName(
     git: Readonly<SimpleGit>,
-    repoConfig: Readonly<Pick<DeployVirRepoConfig, 'name' | 'girUrl'>>,
+    repoConfig: Readonly<Pick<DeployVirRepoConfig, 'name' | 'gitUrl'>>,
 ): Promise<string> {
     assert.isTruthy(repoConfig.name, 'Repo config name cannot be empty.');
-    assert.isTruthy(repoConfig.girUrl, 'Repo git URL 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.girUrl || remote.refs.push === repoConfig.girUrl,
+            remote.refs.fetch === repoConfig.gitUrl || remote.refs.push === repoConfig.gitUrl,
     );
 
     if (remoteMatchByUrl) {
@@ -40,7 +40,7 @@ export async function getGitRemoteName(
         .filter(check.isTruthy)
         .join('-');
 
-    await git.addRemote(newRemoteName, repoConfig.girUrl);
+    await git.addRemote(newRemoteName, repoConfig.gitUrl);
 
     return newRemoteName;
 }
@@ -76,6 +76,8 @@ export async function pushDeploy(
     assert.isTruthy(toBranch, `Deploy '${deployName}' toBranch cannot be empty.`);
     assert.isTruthy(remoteName, 'Remote name cannot be empty.');
 
+    log.faint(`Pushing ${remoteName}/${fromBranch} to ${toBranch}`);
+
     await git.fetch(remoteName, fromBranch);
 
     const pushString = `${remoteName}/${fromBranch}:${toBranch}`;

package/src/notifications/slack.ts

@@ -44,11 +44,11 @@ export async function sendNotificationToSlack({
     );
 
     const deployedCommitBulletsText = deployedCommitBullets
-        .map((bullet) => `• ${bullet}`)
+        .map((bullet) => `- ${bullet}`)
         .join('\n');
 
     const overwrittenCommitBulletsText = overwrittenCommitBullets.length
-        ? overwrittenCommitBullets.map((bullet) => `• ${bullet}`).join('\n')
+        ? overwrittenCommitBullets.map((bullet) => `- ${bullet}`).join('\n')
         : undefined;
 
     const blocks: any[] = [