@akash-chowdhury-24/deployhub 2.0.5 → 2.0.7

package/src/utils/github-actions.js

@@ -3,7 +3,8 @@ import path from 'path';
 import { getWorkflowHeaderComment } from './author.js';
 import {
   generateDeploymentEnvSection,
-  getDeploymentSecretKeys,
+  getDeploymentWorkflowSecretKeys,
+  getDeploymentSecretChecklistItems,
   DEPLOYMENT_ENV_KEYS,
 } from '../deployment/deployment-env.js';
 
@@ -287,7 +288,7 @@ export function generateWorkflowYaml(
     const env = environments[envName];
     if (!env) continue;
 
-    const keys = getDeploymentSecretKeys(env.type, config);
+    const keys = getDeploymentWorkflowSecretKeys(env.type, config);
     for (const key of keys) {
       envVars.add(`${key}: \${{ secrets.${key} }}`);
     }
@@ -438,10 +439,12 @@ export async function guessCliGithubRepo(cwd = process.cwd()) {
 }
 
 /**
+ * Flat list of required secret key names (for callers that only need keys).
  * @param {string[]} storageProviders
  * @param {string[]} deployEnvironments
  * @param {Record<string, { type: string }>} environments
  * @param {import('../core/config.js').DeployHubConfig} [config]
+ * @param {string|null} [cliSource]
  * @returns {string[]}
  */
 export function getRequiredSecrets(
@@ -451,28 +454,69 @@ export function getRequiredSecrets(
   config = null,
   cliSource = null
 ) {
-  /** @type {Set<string>} */
-  const secrets = new Set();
+  return getGithubSecretsChecklist(
+    storageProviders,
+    deployEnvironments,
+    environments,
+    config,
+    cliSource
+  )
+    .filter((item) => item.required)
+    .map((item) => item.key);
+}
+
+/**
+ * Labeled GitHub Secrets checklist (required + optional) for post-init output.
+ * @param {string[]} storageProviders
+ * @param {string[]} deployEnvironments
+ * @param {Record<string, { type: string }>} environments
+ * @param {import('../core/config.js').DeployHubConfig} [config]
+ * @param {string|null} [cliSource]
+ * @returns {import('../deployment/deployment-env.js').SecretChecklistItem[]}
+ */
+export function getGithubSecretsChecklist(
+  storageProviders,
+  deployEnvironments,
+  environments,
+  config = null,
+  cliSource = null
+) {
+  /** @type {Map<string, import('../deployment/deployment-env.js').SecretChecklistItem>} */
+  const byKey = new Map();
 
   const resolvedCliSource = cliSource || config?.cli?.source;
   if (isGithubCliSource(resolvedCliSource)) {
-    secrets.add(GITHUB_CLI_TOKEN_SECRET);
+    byKey.set(GITHUB_CLI_TOKEN_SECRET, {
+      key: GITHUB_CLI_TOKEN_SECRET,
+      required: true,
+      note: 'required when installing DeployHub CLI from a private GitHub repo',
+    });
   }
 
   for (const provider of storageProviders) {
     const keys = PROVIDER_ENV_MAP[provider] || [];
-    keys.forEach((k) => secrets.add(k));
+    for (const key of keys) {
+      byKey.set(key, { key, required: true });
+    }
   }
 
   for (const envName of deployEnvironments) {
     const env = environments[envName];
-    if (!env) continue;
+    if (!env?.type) continue;
 
-    const keys = getDeploymentSecretKeys(env.type, config);
-    keys.forEach((k) => secrets.add(k));
+    for (const item of getDeploymentSecretChecklistItems(env.type, config)) {
+      const existing = byKey.get(item.key);
+      if (existing) {
+        if (item.required && !existing.required) {
+          byKey.set(item.key, item);
+        }
+        continue;
+      }
+      byKey.set(item.key, item);
+    }
   }
 
-  return Array.from(secrets);
+  return Array.from(byKey.values());
 }
 
 /**

package/src/utils/scaffold.js

@@ -3,6 +3,7 @@ import path from 'path';
 import chalk from 'chalk';
 import {
   generateDockerfile,
+  generateDockerignore,
   getDockerfileFrameworkLabel,
   resolveDockerSettings,
 } from './dockerfile.js';
@@ -48,11 +49,11 @@ export function needsKubernetesManifests(
  * @param {string} cwd
  * @param {import('../core/config.js').DeployHubConfig} config
  * @param {{ silent?: boolean }} [options]
- * @returns {Promise<{ generated: boolean, framework?: string }>}
+ * @returns {Promise<{ generated: boolean }>}
  */
-export async function ensureDockerfile(cwd, config, options = {}) {
-  const dockerfilePath = path.join(cwd, 'Dockerfile');
-  if (await fs.pathExists(dockerfilePath)) {
+export async function ensureDockerignore(cwd, config, options = {}) {
+  const dockerignorePath = path.join(cwd, '.dockerignore');
+  if (await fs.pathExists(dockerignorePath)) {
     return { generated: false };
   }
 
@@ -60,20 +61,56 @@ export async function ensureDockerfile(cwd, config, options = {}) {
     return { generated: false };
   }
 
-  const settings = resolveDockerSettings(config);
-  const content = generateDockerfile(config);
-  await fs.writeFile(dockerfilePath, content);
+  await fs.writeFile(dockerignorePath, generateDockerignore(config));
 
   if (!options.silent) {
-    const label = getDockerfileFrameworkLabel(settings.framework);
     console.log(
       chalk.yellow(
-        `No Dockerfile found — generated a starter Dockerfile at ./Dockerfile based on your detected ${label}. Review it before deploying, especially the exposed port and start command.`
+        'No .dockerignore found — generated one at ./.dockerignore to keep node_modules and build caches out of the Docker build context.'
       )
     );
   }
 
-  return { generated: true, framework: settings.framework };
+  return { generated: true };
+}
+
+/**
+ * @param {string} cwd
+ * @param {import('../core/config.js').DeployHubConfig} config
+ * @param {{ silent?: boolean }} [options]
+ * @returns {Promise<{ generated: boolean, framework?: string, dockerignoreGenerated?: boolean }>}
+ */
+export async function ensureDockerfile(cwd, config, options = {}) {
+  const dockerfilePath = path.join(cwd, 'Dockerfile');
+  let generated = false;
+  /** @type {string|undefined} */
+  let framework;
+
+  if (!(await fs.pathExists(dockerfilePath)) && needsDockerfile(config)) {
+    const settings = resolveDockerSettings(config);
+    const content = generateDockerfile(config);
+    await fs.writeFile(dockerfilePath, content);
+    generated = true;
+    framework = settings.framework;
+
+    if (!options.silent) {
+      const label = getDockerfileFrameworkLabel(settings.framework);
+      console.log(
+        chalk.yellow(
+          `No Dockerfile found — generated a starter Dockerfile at ./Dockerfile based on your detected ${label}. Review it before deploying, especially the exposed port and start command.`
+        )
+      );
+    }
+  }
+
+  // Always pair Dockerfile generation path with .dockerignore (never overwrite existing)
+  const dockerignoreResult = await ensureDockerignore(cwd, config, options);
+
+  return {
+    generated,
+    framework,
+    dockerignoreGenerated: dockerignoreResult.generated,
+  };
 }
 
 /**
@@ -133,6 +170,7 @@ export async function ensureDeployScaffold(
   const k8sResult = await ensureKubernetesManifests(cwd, config, environments, options);
   return {
     dockerfile: dockerResult.generated,
+    dockerignore: Boolean(dockerResult.dockerignoreGenerated),
     kubernetes: k8sResult.generated,
   };
 }
@@ -183,6 +221,7 @@ export async function copyDeployAssetsToArtifactDir(stagingDir, artifactDir) {
 
 export default {
   ensureDockerfile,
+  ensureDockerignore,
   ensureKubernetesManifests,
   ensureDeployScaffold,
   needsDockerfile,