@akash-chowdhury-24/deployhub 2.0.26 → 2.0.28

package/src/utils/github-actions.js

@@ -18,12 +18,27 @@ import {
 } from '../deployment/deployment-env.js';
 import {
   getEnvMethod,
+  getEnvTrigger,
   getEnabledEnvironmentNames,
   isEnvEnabled,
 } from '../core/environments.js';
 
+/** Default PHP for CI when config does not set `phpVersion` / `backend.phpVersion`. */
+export const DEFAULT_PHP_VERSION = '8.4';
+
 /** @typedef {'aws'|'azure'|'gcp'|'gdrive'|'dropbox'|'local'|'ftp'|'ssh'} ProviderEnvKey */
 
+/** Storage-only providers — never treat deployment method ids as storage. */
+const STORAGE_PROVIDER_IDS = new Set([
+  'aws',
+  'azure',
+  'gcp',
+  'gdrive',
+  'dropbox',
+  'local',
+  'ftp',
+]);
+
 const PROVIDER_ENV_MAP = {
   aws: [
     'AWS_ACCESS_KEY_ID',
@@ -41,7 +56,7 @@ const PROVIDER_ENV_MAP = {
   ],
   dropbox: ['DROPBOX_ACCESS_TOKEN'],
   local: [],
-  ftp: ['FTP_HOST', 'FTP_USER', 'FTP_PASSWORD'],
+  ftp: ['FTP_HOST', 'FTP_USER', 'FTP_PASSWORD', 'FTP_PORT', 'FTP_PATH'],
   ssh: DEPLOYMENT_ENV_KEYS.ssh,
   docker: DEPLOYMENT_ENV_KEYS.docker,
   ec2: DEPLOYMENT_ENV_KEYS.ec2,
@@ -50,6 +65,27 @@ const PROVIDER_ENV_MAP = {
   kubernetes: DEPLOYMENT_ENV_KEYS.kubernetes,
 };
 
+/** @type {Record<string, string>} */
+const STORAGE_SECRET_NOTES = {
+  AWS_ACCESS_KEY_ID: 'AWS S3 storage credential (not EC2 instance lookup)',
+  AWS_SECRET_ACCESS_KEY: 'AWS S3 storage credential (not EC2 instance lookup)',
+  AWS_BUCKET: 'AWS S3 storage bucket',
+  AWS_REGION: 'AWS S3 storage region (not EC2_LOOKUP_AWS_REGION)',
+  AZURE_CONNECTION_STRING: 'Azure Blob storage credential',
+  AZURE_CONTAINER: 'Azure Blob storage container',
+  GCP_PROJECT_ID: 'GCP Storage credential (not GCP VM instance lookup)',
+  GCP_KEY_FILE: 'GCP Storage credential (not GCP_VM_LOOKUP_KEY_FILE)',
+  GCP_BUCKET: 'GCP Storage bucket',
+  GDRIVE_CLIENT_ID: 'Google Drive storage credential',
+  GDRIVE_CLIENT_SECRET: 'Google Drive storage credential',
+  GDRIVE_REFRESH_TOKEN: 'Google Drive storage credential',
+  GDRIVE_FOLDER_ID: 'Google Drive folder',
+  DROPBOX_ACCESS_TOKEN: 'Dropbox storage credential',
+  FTP_HOST: 'FTP storage host',
+  FTP_USER: 'FTP storage user',
+  FTP_PASSWORD: 'FTP storage password',
+};
+
 const PROVIDER_LABELS = {
   aws: 'AWS S3',
   azure: 'Azure Blob',
@@ -67,6 +103,7 @@ const PROVIDER_LABELS = {
 
 const ENV_VAR_DEFAULTS = {
   AWS_REGION: 'us-east-1',
+  EC2_LOOKUP_AWS_REGION: 'us-east-1',
   FTP_PORT: '21',
   FTP_PATH: '/uploads',
   SSH_DEPLOY_PATH: '/var/www/app',
@@ -234,6 +271,40 @@ function getGithubGitConfigStep() {
           fi`;
 }
 
+/**
+ * Resolve PHP version for CI setup-php.
+ * Order: `backend.phpVersion` → top-level `phpVersion` → {@link DEFAULT_PHP_VERSION} (`8.4`).
+ * Set either config key in deployhub.config.json to pin a different runtime
+ * (e.g. `"phpVersion": "8.3"` or `"backend": { "phpVersion": "8.3" }`).
+ *
+ * @param {import('../core/config.js').DeployHubConfig} [config]
+ * @returns {string}
+ */
+export function resolvePhpVersion(config) {
+  const fromBackend = config?.backend?.phpVersion;
+  if (typeof fromBackend === 'string' && fromBackend.trim()) {
+    return fromBackend.trim();
+  }
+  const fromRoot = config?.phpVersion;
+  if (typeof fromRoot === 'string' && fromRoot.trim()) {
+    return fromRoot.trim();
+  }
+  return DEFAULT_PHP_VERSION;
+}
+
+/**
+ * @param {import('../core/config.js').DeployHubConfig} [config]
+ * @returns {boolean}
+ */
+function isPhpProject(config) {
+  if (!config) return false;
+  const projectType = config.projectType || 'frontend';
+  if (projectType !== 'backend' && projectType !== 'both') return false;
+  const framework = config.backend?.framework || config.framework || '';
+  const language = config.backend?.language || config.language || '';
+  return language === 'php' || ['laravel', 'symfony', 'php'].includes(framework);
+}
+
 /**
  * @param {import('../core/config.js').DeployHubConfig} [config]
  * @returns {string[]}
@@ -249,16 +320,24 @@ function getBackendSetupSteps(config) {
 
   if (projectType === 'backend' || projectType === 'both') {
     const framework = config.backend?.framework || config.framework || 'express';
-    if (['express', 'nestjs', 'fastify', 'koa', 'nextjs'].includes(framework)) {
+    if (['express', 'nestjs', 'fastify', 'koa', 'nextjs', 'node'].includes(framework)) {
       steps.push(`      - uses: actions/setup-node@v4
         with:
           node-version: '20'`);
     }
-    if (['fastapi', 'django', 'flask'].includes(framework)) {
+    if (['fastapi', 'django', 'flask', 'python'].includes(framework)) {
       steps.push(`      - uses: actions/setup-python@v5
         with:
           python-version: '3.11'`);
     }
+    if (isPhpProject(config)) {
+      const phpVersion = resolvePhpVersion(config);
+      steps.push(`      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: '${phpVersion}'
+          tools: composer`);
+    }
     if (['spring', 'java'].includes(framework)) {
       steps.push(`      - uses: actions/setup-java@v4
         with:
@@ -275,7 +354,7 @@ function getBackendSetupSteps(config) {
         with:
           dotnet-version: '8.0.x'`);
     }
-    if (framework === 'rails') {
+    if (framework === 'rails' || framework === 'ruby') {
       steps.push(`      - uses: ruby/setup-ruby@v1
         with:
           ruby-version: '3.2'
@@ -329,18 +408,69 @@ function resolveKubeconfigWorkflowSecretName(deployEnvironments, environments, c
     : 'KUBECONFIG';
 }
 
+/**
+ * GitHub Actions `if:` so kubectl/kubeconfig only run when this job needs k8s.
+ * - Push: only when at least one push-triggered env uses kubernetes (skip when push
+ *   only deploys EC2/SSH/etc. and k8s is manual-only).
+ * - workflow_dispatch / rollback: when selected env is k8s, `all`, or blank
+ *   (blank = deploy/rollback all enabled envs).
+ * Returns null when every enabled env is kubernetes (steps always needed).
+ *
+ * @param {string[]} deployEnvironments
+ * @param {Record<string, { type?: string, method?: string, trigger?: string }>} environments
+ * @param {'deploy'|'rollback'} [kind]
+ * @returns {string|null}
+ */
+function getKubernetesSetupIfExpression(
+  deployEnvironments,
+  environments,
+  kind = 'deploy'
+) {
+  const k8sNames = deployEnvironments.filter(
+    (n) => getEnvMethod(environments[n]) === 'kubernetes'
+  );
+  if (k8sNames.length === 0) return null;
+
+  const nonK8s = deployEnvironments.filter(
+    (n) => getEnvMethod(environments[n]) !== 'kubernetes'
+  );
+  // All enabled envs are kubernetes — setup is always required.
+  if (nonK8s.length === 0) return null;
+
+  const dispatchNeedK8s = [
+    ...k8sNames.map((n) => `inputs.environment == '${n}'`),
+    `inputs.environment == 'all'`,
+    `inputs.environment == ''`,
+  ].join(' || ');
+
+  if (kind === 'rollback') {
+    return `github.event_name == 'workflow_dispatch' && (${dispatchNeedK8s})`;
+  }
+
+  const pushK8s = k8sNames.filter(
+    (n) => getEnvTrigger(environments[n]) === 'push'
+  );
+  if (pushK8s.length > 0) {
+    return `github.event_name == 'push' || (github.event_name == 'workflow_dispatch' && (${dispatchNeedK8s}))`;
+  }
+  // Manual-only kubernetes: never configure kubeconfig on plain push.
+  return `github.event_name == 'workflow_dispatch' && (${dispatchNeedK8s})`;
+}
+
 /**
  * @param {string} [kubeconfigSecretName]
+ * @param {string|null} [ifExpression]
  * @returns {string}
  */
-function getKubernetesSetupSteps(kubeconfigSecretName = 'KUBECONFIG') {
+function getKubernetesSetupSteps(kubeconfigSecretName = 'KUBECONFIG', ifExpression = null) {
   // One kubeconfig file per job — see resolveKubeconfigWorkflowSecretName LIMITATION.
-  return `      - name: Setup kubectl
+  const ifLine = ifExpression ? `\n        if: ${ifExpression}` : '';
+  return `      - name: Setup kubectl${ifLine}
         uses: azure/setup-kubectl@v4
         with:
           version: '${KUBECTL_VERSION}'
 
-      - name: Configure kubeconfig
+      - name: Configure kubeconfig${ifLine}
         env:
           KUBECONFIG_SECRET: \${{ secrets.${kubeconfigSecretName} }}
         run: |
@@ -416,6 +546,7 @@ export function buildWorkflowEnvEntries(
   ]);
 
   for (const provider of storageProviders) {
+    if (!STORAGE_PROVIDER_IDS.has(provider)) continue;
     const keys = PROVIDER_ENV_MAP[provider] || [];
     for (const key of keys) {
       upsertWorkflowEnvLine(envVars, key, `\${{ secrets.${key} }}`);
@@ -546,8 +677,13 @@ export function generateWorkflowYaml(
     environments,
     config
   );
+  const k8sIf = getKubernetesSetupIfExpression(
+    allDeployNames,
+    environments,
+    'deploy'
+  );
   const kubernetesSteps = hasKubernetesDeploy(allDeployNames, environments)
-    ? `${getKubernetesSetupSteps(kubeconfigSecret)}\n`
+    ? `${getKubernetesSetupSteps(kubeconfigSecret, k8sIf)}\n`
     : '';
 
   const projectType = config?.projectType || 'frontend';
@@ -654,6 +790,13 @@ export function generateRollbackWorkflowYaml(
   const envBlock = formatWorkflowEnvBlock(envVars);
 
   const installSpec = getCliInstallSpec(cliSource);
+  // Rollback does not generally install project deps; PHP is the exception
+  // (composer install) so we only inject setup-php here — not other backends.
+  const phpSetupSteps = isPhpProject(config)
+    ? [...new Set(getBackendSetupSteps(config))]
+        .filter((s) => s.includes('setup-php'))
+        .join('\n')
+    : '';
   const githubGitConfigStep = isGithubCliSource(cliSource)
     ? `${getGithubGitConfigStep()}\n`
     : '';
@@ -662,14 +805,25 @@ export function generateRollbackWorkflowYaml(
     environments,
     config
   );
+  const k8sIf = getKubernetesSetupIfExpression(
+    allDeployNames,
+    environments,
+    'rollback'
+  );
   const kubernetesSteps = hasKubernetesDeploy(allDeployNames, environments)
-    ? `${getKubernetesSetupSteps(kubeconfigSecret)}\n`
+    ? `${getKubernetesSetupSteps(kubeconfigSecret, k8sIf)}\n`
     : '';
 
   const rollbackCmd = getCliRollbackCommand();
   const envChoiceOptions = formatEnvironmentChoiceOptions(environments);
   const hasEnvs = envNames.length > 0;
 
+  const phpInstallStep = isPhpProject(config)
+    ? `      - name: Install project dependencies
+        run: ${getInstallDepsCommand(config)}
+`
+    : '';
+
   const environmentInput = hasEnvs
     ? `      environment:
         description: 'Environment to roll back (or "all")'
@@ -713,10 +867,10 @@ ${environmentInput}jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
-      - uses: actions/setup-node@v4
+${phpSetupSteps ? `${phpSetupSteps}\n` : ''}      - uses: actions/setup-node@v4
         with:
           node-version: '20'
-${kubernetesSteps}${githubGitConfigStep}      - name: Install DeployHub CLI
+${kubernetesSteps}${githubGitConfigStep}${phpInstallStep}      - name: Install DeployHub CLI
         run: npm install ${installSpec} --no-save
       - name: Rollback
         env:
@@ -737,10 +891,10 @@ function getInstallDepsCommand(config) {
     config.backend?.framework || config.framework || 'express';
   const language = config.backend?.language || config.language;
 
-  if (language === 'python' || ['fastapi', 'django', 'flask'].includes(framework)) {
+  if (language === 'python' || ['fastapi', 'django', 'flask', 'python'].includes(framework)) {
     return 'pip install -r requirements.txt';
   }
-  if (['laravel', 'symfony'].includes(framework)) {
+  if (language === 'php' || ['laravel', 'symfony', 'php'].includes(framework)) {
     return 'composer install --no-interaction';
   }
   if (framework === 'spring' || framework === 'java') {
@@ -752,7 +906,7 @@ function getInstallDepsCommand(config) {
   if (framework === 'dotnet') {
     return 'dotnet restore';
   }
-  if (framework === 'rails') {
+  if (framework === 'rails' || framework === 'ruby') {
     return 'bundle install';
   }
   return 'npm install';
@@ -1202,9 +1356,14 @@ export function getGithubSecretsChecklist(
   }
 
   for (const provider of storageProviders) {
+    if (!STORAGE_PROVIDER_IDS.has(provider)) continue;
     const keys = PROVIDER_ENV_MAP[provider] || [];
     for (const key of keys) {
-      byKey.set(key, { key, required: true });
+      byKey.set(key, {
+        key,
+        required: true,
+        note: STORAGE_SECRET_NOTES[key] || 'storage credential',
+      });
     }
   }
 
@@ -1280,18 +1439,36 @@ export function generateEnvExampleContent(
   };
 
   for (const provider of storageProviders) {
+    // Defensive: ignore accidental deploy-method ids in storageProviders
+    // (PROVIDER_ENV_MAP also maps ec2/ssh/… for workflow wiring).
+    if (!STORAGE_PROVIDER_IDS.has(provider)) continue;
     const keys = PROVIDER_ENV_MAP[provider] || [];
     if (keys.length > 0) {
       addSection(PROVIDER_LABELS[provider] || provider, keys);
     }
   }
 
+  /** @type {Set<string>} */
+  const seenDeployEnvs = new Set();
+  const cfg = {
+    ...(config || {}),
+    environments: environments || config?.environments || {},
+  };
+
   for (const envName of deployEnvironments) {
+    if (seenDeployEnvs.has(envName)) continue;
+    seenDeployEnvs.add(envName);
+
     const env = environments[envName];
     const method = getEnvMethod(env);
     if (!method) continue;
 
-    const deploySection = generateDeploymentEnvSection(method, config, environments);
+    const deploySection = generateDeploymentEnvSection(
+      method,
+      cfg,
+      environments,
+      { envName }
+    );
     if (deploySection) {
       sections.push(`${deploySection}\n`);
     }
@@ -1323,4 +1500,4 @@ export function generateEnvExampleContent(
   return `${sections.join('\n')}\n`;
 }
 
-export { PROVIDER_ENV_MAP };
+export { PROVIDER_ENV_MAP, STORAGE_PROVIDER_IDS };