@akash-chowdhury-24/deployhub 2.0.0 → 2.0.3

package/src/utils/github-actions.js

@@ -1,6 +1,11 @@
 import fs from 'fs-extra';
 import path from 'path';
 import { getWorkflowHeaderComment } from './author.js';
+import {
+  generateDeploymentEnvSection,
+  getDeploymentSecretKeys,
+  DEPLOYMENT_ENV_KEYS,
+} from '../deployment/deployment-env.js';
 
 /** @typedef {'aws'|'azure'|'gcp'|'gdrive'|'dropbox'|'local'|'ftp'|'ssh'} ProviderEnvKey */
 
@@ -22,23 +27,27 @@ const PROVIDER_ENV_MAP = {
   dropbox: ['DROPBOX_ACCESS_TOKEN'],
   local: [],
   ftp: ['FTP_HOST', 'FTP_USER', 'FTP_PASSWORD'],
-  ssh: ['SSH_HOST', 'SSH_USER', 'SSH_KEY'],
+  ssh: DEPLOYMENT_ENV_KEYS.ssh,
+  docker: DEPLOYMENT_ENV_KEYS.docker,
+  ec2: DEPLOYMENT_ENV_KEYS.ec2,
+  'azure-vm': DEPLOYMENT_ENV_KEYS['azure-vm'],
+  'gcp-vm': DEPLOYMENT_ENV_KEYS['gcp-vm'],
+  kubernetes: DEPLOYMENT_ENV_KEYS.kubernetes,
 };
 
-const BACKEND_SSH_ENV_VARS = [
-  'SSH_DEPLOY_PATH',
-  'SSH_APP_NAME',
-  'SSH_PORT',
-];
-
 const PROVIDER_LABELS = {
   aws: 'AWS S3',
   azure: 'Azure Blob',
-  gcp: 'GCP',
+  gcp: 'GCP Storage',
   gdrive: 'Google Drive',
   dropbox: 'Dropbox',
   ftp: 'FTP',
   ssh: 'SSH Deployment',
+  docker: 'Docker Deployment',
+  ec2: 'AWS EC2 Deployment',
+  'azure-vm': 'Azure VM Deployment',
+  'gcp-vm': 'GCP VM Deployment',
+  kubernetes: 'Kubernetes Deployment',
 };
 
 const ENV_VAR_DEFAULTS = {
@@ -46,6 +55,7 @@ const ENV_VAR_DEFAULTS = {
   FTP_PORT: '21',
   FTP_PATH: '/uploads',
   SSH_DEPLOY_PATH: '/var/www/app',
+  SSH_SSH_PORT: '22',
   SMTP_PORT: '587',
 };
 
@@ -227,19 +237,10 @@ export function generateWorkflowYaml(
     const env = environments[envName];
     if (!env) continue;
 
-    const keys = PROVIDER_ENV_MAP[env.type] || [];
+    const keys = getDeploymentSecretKeys(env.type, config);
     for (const key of keys) {
       envVars.add(`${key}: \${{ secrets.${key} }}`);
     }
-
-    if (env.type === 'ssh' && config) {
-      const projectType = config.projectType || 'frontend';
-      if (projectType === 'backend' || projectType === 'both') {
-        for (const key of BACKEND_SSH_ENV_VARS) {
-          envVars.add(`${key}: \${{ secrets.${key} }}`);
-        }
-      }
-    }
   }
 
   const envBlock = Array.from(envVars)
@@ -412,15 +413,8 @@ export function getRequiredSecrets(
     const env = environments[envName];
     if (!env) continue;
 
-    const keys = PROVIDER_ENV_MAP[env.type] || [];
+    const keys = getDeploymentSecretKeys(env.type, config);
     keys.forEach((k) => secrets.add(k));
-
-    if (env.type === 'ssh' && config) {
-      const projectType = config.projectType || 'frontend';
-      if (projectType === 'backend' || projectType === 'both') {
-        BACKEND_SSH_ENV_VARS.forEach((k) => secrets.add(k));
-      }
-    }
   }
 
   return Array.from(secrets);
@@ -481,18 +475,11 @@ export function generateEnvExampleContent(
 
   for (const envName of deployEnvironments) {
     const env = environments[envName];
-    if (!env) continue;
-
-    const keys = PROVIDER_ENV_MAP[env.type] || [];
-    if (keys.length > 0) {
-      addSection(PROVIDER_LABELS[env.type] || env.type, keys);
-    }
+    if (!env?.type) continue;
 
-    if (env.type === 'ssh' && config) {
-      const projectType = config.projectType || 'frontend';
-      if (projectType === 'backend' || projectType === 'both') {
-        addSection('SSH Deployment (backend)', BACKEND_SSH_ENV_VARS);
-      }
+    const deploySection = generateDeploymentEnvSection(env.type, config, environments);
+    if (deploySection) {
+      sections.push(`${deploySection}\n`);
     }
   }
 

package/src/{rollback → utils/rollback}/engine.js

@@ -1,12 +1,12 @@
-import { downloadFromFirst } from '../storage/index.js';
-import { getDeploymentProvider } from '../deployment/index.js';
-import { extractArtifact } from '../artifact/engine.js';
-import { createLogger } from '../logger/index.js';
+import { downloadFromFirst } from '../../storage/index.js';
+import { getDeploymentProvider } from '../../deployment/index.js';
+import { extractArtifact } from '../../artifact/engine.js';
+import { createLogger } from '../../logger/index.js';
 import fs from 'fs-extra';
 import path from 'path';
 
 /**
- * @param {import('../core/config.js').DeployHubConfig} config
+ * @param {import('../../core/config.js').DeployHubConfig} config
  * @param {string} artifactDir
  * @param {string} envName
  */
@@ -24,7 +24,7 @@ async function rollbackTarget(config, artifactDir, envName) {
 }
 
 /**
- * @param {import('../core/config.js').DeployHubConfig} config
+ * @param {import('../../core/config.js').DeployHubConfig} config
  * @param {string} version
  * @param {string} [cwd]
  */

package/src/utils/shell-quote.js

@@ -0,0 +1,64 @@
+/**
+ * Wrap a value for safe interpolation into a POSIX shell command string.
+ * Uses single quotes; embedded single quotes are escaped as '\''.
+ * @param {string} value
+ * @returns {string}
+ */
+export function shellQuote(value) {
+  if (value == null) return "''";
+  return `'${String(value).replace(/'/g, `'\\''`)}'`;
+}
+
+/**
+ * @param {string} command
+ * @param {number|null|undefined} code
+ * @param {string} [stderr]
+ * @param {string} [stdout]
+ * @returns {string}
+ */
+export function formatRemoteCommandFailure(command, code, stderr, stdout) {
+  const cmdName = command.trim().split(/\s+/)[0] || 'command';
+  const detail = (stderr || stdout || '').trim();
+  return `Deploy failed: ${cmdName} exited with code ${code}${detail ? `: ${detail}` : ''}`;
+}
+
+/**
+ * Remote shell command that verifies write access to a deploy directory.
+ * @param {string} deployPath
+ * @returns {string}
+ */
+export function buildDeployPathWriteTestCommand(deployPath) {
+  const dir = shellQuote(deployPath);
+  const testFile = shellQuote(`${deployPath}/.deployhub-write-test`);
+  return `mkdir -p ${dir} && touch ${testFile} && rm -f ${testFile}`;
+}
+
+/**
+ * @param {string} deployPath
+ * @param {string} sshUser
+ * @param {string} [errorDetail]
+ * @returns {string}
+ */
+export function formatDeployPathWriteFailure(deployPath, sshUser, errorDetail) {
+  const reason = errorDetail ? ` (${errorDetail.trim()})` : '';
+  const quotedPath = shellQuote(deployPath);
+  return (
+    `Cannot write to ${deployPath} on the server${reason}.\n` +
+    `  Run this on your server first:\n` +
+    `    sudo mkdir -p ${quotedPath}\n` +
+    `    sudo chown ${sshUser}:${sshUser} ${quotedPath}\n` +
+    `  (replace ${sshUser} with your actual SSH_USER if different)`
+  );
+}
+
+/**
+ * @param {string} name
+ * @returns {string}
+ */
+export function toKebabCase(name) {
+  return name
+    .trim()
+    .replace(/\s+/g, '-')
+    .replace(/[^a-zA-Z0-9-_]/g, '')
+    .toLowerCase();
+}