@akash-chowdhury-24/deployhub 1.0.7 → 1.0.9

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@akash-chowdhury-24/deployhub",
-  "version": "1.0.7",
+  "version": "1.0.9",
   "description": "Zero-configuration deployment and artifact manager",
   "type": "module",
   "main": "./src/cli/index.js",

package/src/commands/init.js

@@ -14,8 +14,11 @@ import { getProjectVersion } from '../utils/version.js';
 import {
   writeWorkflowFile,
   getRequiredSecrets,
+  generateEnvExampleContent,
   guessCliGithubRepo,
   addDeployhubToPackageJson,
+  isGithubCliSource,
+  normalizeGithubCliSource,
 } from '../utils/github-actions.js';
 import {
   promptPlatformQuestions,
@@ -288,25 +291,6 @@ function buildServerEnvEntry(
   return envEntry;
 }
 
-/**
- * @returns {Promise<string>}
- */
-async function getEnvExampleContent() {
-  const possiblePaths = [
-    path.join(path.dirname(process.execPath), '.env.example'),
-    path.join(process.cwd(), '.env.example'),
-    new URL('../../.env.example', import.meta.url).pathname,
-  ];
-  for (const p of possiblePaths) {
-    try {
-      return await fs.readFile(p, 'utf-8');
-    } catch {
-      // try next path
-    }
-  }
-  return '# Add your environment variables here\n';
-}
-
 /**
  * @param {Record<string, unknown>} config
  * @param {Record<string, Record<string, unknown>>} environments
@@ -470,6 +454,7 @@ export function registerInitCommand(program) {
           message:
             'DeployHub CLI source for GitHub Actions (github:user/repo or npm:@akash-chowdhury-24/deployhub):',
           default: defaultCliRepo,
+          filter: (value) => normalizeGithubCliSource(value),
         },
       ]);
 
@@ -780,7 +765,12 @@ export function registerInitCommand(program) {
       await generateProjectScaffold(config, environments, cwd);
 
       const envExampleDest = path.join(cwd, '.env.example');
-      const envExampleContent = await getEnvExampleContent();
+      const envExampleContent = generateEnvExampleContent(
+        config.storage,
+        deploy,
+        environments,
+        config
+      );
       await fs.writeFile(envExampleDest, envExampleContent);
 
       const secrets = getRequiredSecrets(config.storage, deploy, environments, config);
@@ -794,7 +784,17 @@ export function registerInitCommand(program) {
       console.log('  • .env.example');
       console.log('');
       console.log(chalk.bold('Next steps:'));
-      console.log('  1. Push the DeployHub CLI repo to GitHub (if using github: source)');
+      if (isGithubCliSource(answers.cliSource)) {
+        console.log(
+          '  1. For a private DeployHub CLI repo, create a GitHub PAT with repo read access'
+        );
+        console.log(
+          `     and add it as ${chalk.cyan('DEPLOYHUB_GITHUB_TOKEN')} in your demo project secrets`
+        );
+        console.log('     (public CLI repos can skip this — HTTPS is used automatically)');
+      } else {
+        console.log('  1. Push the DeployHub CLI repo to GitHub (if using github: source)');
+      }
       console.log('  2. Copy .env.example to .env and fill in credentials');
       if (secrets.length > 0) {
         console.log('  3. Add these secrets to GitHub (Settings → Secrets):');

package/src/utils/github-actions.js

@@ -1,6 +1,11 @@
 import fs from 'fs-extra';
 import path from 'path';
-import { PLATFORM_ENV_MAP, PLATFORM_CLI_MAP } from './platform-env.js';
+import {
+  PLATFORM_ENV_MAP,
+  PLATFORM_CLI_MAP,
+  PLATFORM_CHOICES,
+  getPlatformEnvExample,
+} from './platform-env.js';
 import { getWorkflowHeaderComment } from './author.js';
 
 /** @typedef {'aws'|'azure'|'gcp'|'gdrive'|'dropbox'|'local'|'ftp'|'ssh'} ProviderEnvKey */
@@ -32,8 +37,68 @@ const BACKEND_SSH_ENV_VARS = [
   'SSH_PORT',
 ];
 
+const PROVIDER_LABELS = {
+  aws: 'AWS S3',
+  azure: 'Azure Blob',
+  gcp: 'GCP',
+  gdrive: 'Google Drive',
+  dropbox: 'Dropbox',
+  ftp: 'FTP',
+  ssh: 'SSH Deployment',
+};
+
+const PLATFORM_LABELS = Object.fromEntries(
+  PLATFORM_CHOICES.map(({ name, value }) => [value, name])
+);
+
+const ENV_VAR_DEFAULTS = {
+  AWS_REGION: 'us-east-1',
+  FTP_PORT: '21',
+  FTP_PATH: '/uploads',
+  SSH_DEPLOY_PATH: '/var/www/app',
+  SMTP_PORT: '587',
+};
+
 const NPM_PACKAGE = '@akash-chowdhury-24/deployhub';
 const DEFAULT_NPM_CLI_SOURCE = `npm:${NPM_PACKAGE}`;
+export const GITHUB_CLI_TOKEN_SECRET = 'DEPLOYHUB_GITHUB_TOKEN';
+
+/**
+ * @param {string} [cliSource]
+ * @returns {boolean}
+ */
+export function isGithubCliSource(cliSource) {
+  const normalized = normalizeCliSource(cliSource);
+  return normalized.startsWith('github:');
+}
+
+/**
+ * Normalizes common GitHub remote formats to github:user/repo.
+ * @param {string} cliSource
+ * @returns {string}
+ */
+export function normalizeGithubCliSource(cliSource) {
+  if (!cliSource) return cliSource;
+
+  const trimmed = cliSource.trim();
+  const httpsMatch = trimmed.match(
+    /^https?:\/\/github\.com\/([^/]+)\/([^/#?]+?)(?:\.git)?(?:[/?#].*)?$/
+  );
+  if (httpsMatch) {
+    return `github:${httpsMatch[1]}/${httpsMatch[2]}`;
+  }
+
+  const sshMatch = trimmed.match(/^git@github\.com:([^/]+)\/([^/#?]+?)(?:\.git)?$/);
+  if (sshMatch) {
+    return `github:${sshMatch[1]}/${sshMatch[2]}`;
+  }
+
+  if (trimmed.startsWith('github:')) {
+    return trimmed.replace(/^github:/, 'github:').replace(/\.git$/, '');
+  }
+
+  return trimmed;
+}
 
 /** @param {string} [cliSource] */
 function normalizeCliSource(cliSource) {
@@ -41,7 +106,7 @@ function normalizeCliSource(cliSource) {
   if (/^npm:(deployhub-cli|deploy-hub-cli|deployhub)$/.test(cliSource)) {
     return DEFAULT_NPM_CLI_SOURCE;
   }
-  return cliSource;
+  return normalizeGithubCliSource(cliSource);
 }
 
 /**
@@ -62,6 +127,26 @@ export function getCliInstallSpec(cliSource) {
   return normalized;
 }
 
+/**
+ * @returns {string}
+ */
+function getGithubGitConfigStep() {
+  return `      - name: Configure GitHub access for DeployHub CLI
+        env:
+          ${GITHUB_CLI_TOKEN_SECRET}: \${{ secrets.${GITHUB_CLI_TOKEN_SECRET} }}
+          GITHUB_TOKEN: \${{ github.token }}
+        run: |
+          TOKEN="\${${GITHUB_CLI_TOKEN_SECRET}:-$GITHUB_TOKEN}"
+          if [ -n "$TOKEN" ]; then
+            git config --global url."https://oauth2:\${TOKEN}@github.com/".insteadOf "https://github.com/"
+            git config --global url."https://oauth2:\${TOKEN}@github.com/".insteadOf "git@github.com:"
+            git config --global url."https://oauth2:\${TOKEN}@github.com/".insteadOf "ssh://git@github.com/"
+          else
+            git config --global url."https://github.com/".insteadOf "ssh://git@github.com/"
+            git config --global url."https://github.com/".insteadOf "git@github.com:"
+          fi`;
+}
+
 /**
  * @param {import('../core/config.js').DeployHubConfig} [config]
  * @returns {string[]}
@@ -219,6 +304,9 @@ export function generateWorkflowYaml(
   const installSpec = getCliInstallSpec(cliSource);
   const backendSteps = getBackendSetupSteps(config);
   const uniqueBackendSteps = [...new Set(backendSteps)].join('\n');
+  const githubGitConfigStep = isGithubCliSource(cliSource)
+    ? `${getGithubGitConfigStep()}\n`
+    : '';
 
   const envList = deployEnvironments
     .map((name) => environments[name])
@@ -243,7 +331,7 @@ jobs:
 ${uniqueBackendSteps ? `${uniqueBackendSteps}\n` : ''}      - uses: actions/setup-node@v4
         with:
           node-version: '20'
-      - name: Install project dependencies
+${githubGitConfigStep}      - name: Install project dependencies
         run: ${installDepsCommand}
 ${platformSteps ? `${platformSteps}\n` : ''}      - name: Install DeployHub CLI
         run: npm install ${installSpec} --no-save
@@ -364,11 +452,17 @@ export function getRequiredSecrets(
   storageProviders,
   deployEnvironments,
   environments,
-  config = null
+  config = null,
+  cliSource = null
 ) {
   /** @type {Set<string>} */
   const secrets = new Set();
 
+  const resolvedCliSource = cliSource || config?.cli?.source;
+  if (isGithubCliSource(resolvedCliSource)) {
+    secrets.add(GITHUB_CLI_TOKEN_SECRET);
+  }
+
   for (const provider of storageProviders) {
     const keys = PROVIDER_ENV_MAP[provider] || [];
     keys.forEach((k) => secrets.add(k));
@@ -400,4 +494,113 @@ export function getRequiredSecrets(
   return Array.from(secrets);
 }
 
+/**
+ * @param {string} title
+ * @param {string[]} keys
+ * @param {Record<string, string>} [defaults]
+ * @param {Set<string>} seenKeys
+ * @returns {string}
+ */
+function formatEnvSection(title, keys, defaults, seenKeys) {
+  const newKeys = keys.filter((key) => !seenKeys.has(key));
+  if (newKeys.length === 0) return '';
+
+  for (const key of newKeys) {
+    seenKeys.add(key);
+  }
+
+  const lines = newKeys.map((key) => {
+    const value = defaults?.[key] ?? ENV_VAR_DEFAULTS[key] ?? '';
+    return value ? `${key}=${value}` : `${key}=`;
+  });
+
+  return `# ${title}\n${lines.join('\n')}\n`;
+}
+
+/**
+ * @param {string[]} storageProviders
+ * @param {string[]} deployEnvironments
+ * @param {Record<string, Record<string, unknown>>} environments
+ * @param {import('../core/config.js').DeployHubConfig} [config]
+ * @returns {string}
+ */
+export function generateEnvExampleContent(
+  storageProviders,
+  deployEnvironments,
+  environments,
+  config = null
+) {
+  /** @type {Set<string>} */
+  const seenKeys = new Set();
+  /** @type {string[]} */
+  const sections = [];
+
+  const addSection = (title, keys, defaults = {}) => {
+    const section = formatEnvSection(title, keys, defaults, seenKeys);
+    if (section) sections.push(section);
+  };
+
+  for (const provider of storageProviders) {
+    const keys = PROVIDER_ENV_MAP[provider] || [];
+    if (keys.length > 0) {
+      addSection(PROVIDER_LABELS[provider] || provider, keys);
+    }
+  }
+
+  for (const envName of deployEnvironments) {
+    const env = environments[envName];
+    if (!env) continue;
+
+    if (env.deploymentType === 'platform' || env.frontendDeploymentType === 'platform') {
+      const platform = env.platform;
+      if (platform) {
+        const examples = getPlatformEnvExample(platform);
+        addSection(
+          PLATFORM_LABELS[platform] || platform,
+          Object.keys(examples),
+          examples
+        );
+      }
+      continue;
+    }
+
+    const keys = PROVIDER_ENV_MAP[env.type] || [];
+    if (keys.length > 0) {
+      addSection(PROVIDER_LABELS[env.type] || env.type, keys);
+    }
+
+    if (env.type === 'ssh' && config) {
+      const projectType = config.projectType || 'frontend';
+      if (projectType === 'backend' || projectType === 'both') {
+        addSection('SSH Deployment (backend)', BACKEND_SSH_ENV_VARS);
+      }
+    }
+  }
+
+  if (config?.notifications) {
+    if (config.notifications.slack) {
+      addSection('Notifications', ['SLACK_WEBHOOK_URL']);
+    }
+    if (config.notifications.webhook) {
+      addSection('Notifications', ['WEBHOOK_URL']);
+    }
+    if (config.notifications.email) {
+      addSection('Email (SMTP)', [
+        'SMTP_HOST',
+        'SMTP_PORT',
+        'SMTP_USER',
+        'SMTP_PASS',
+        'NOTIFICATION_EMAIL',
+        'NOTIFY_EMAIL_TO',
+      ]);
+    }
+  }
+
+  if (sections.length === 0) {
+    return '# Add your environment variables here\n';
+  }
+
+  return `${sections.join('\n')}\n`;
+}
+
 export { PROVIDER_ENV_MAP };