netlify-cli 8.5.0 → 8.6.0

package/README.md

@@ -134,6 +134,7 @@ Local dev server
 | [`env:get`](/docs/commands/env.md#envget) | Get resolved value of specified environment variable (includes netlify.toml)  |
 | [`env:import`](/docs/commands/env.md#envimport) | Import and set environment variables from .env file  |
 | [`env:list`](/docs/commands/env.md#envlist) | Lists resolved environment variables for site (includes netlify.toml)  |
+| [`env:migrate`](/docs/commands/env.md#envmigrate) | Migrate environment variables from one site to another  |
 | [`env:set`](/docs/commands/env.md#envset) | Set value of environment variable  |
 | [`env:unset`](/docs/commands/env.md#envunset) | Unset an environment variable which removes it from the UI  |
 

package/npm-shrinkwrap.json

@@ -1,12 +1,12 @@
 {
   "name": "netlify-cli",
-  "version": "8.5.0",
+  "version": "8.6.0",
   "lockfileVersion": 2,
   "requires": true,
   "packages": {
     "": {
       "name": "netlify-cli",
-      "version": "8.5.0",
+      "version": "8.6.0",
       "hasInstallScript": true,
       "license": "MIT",
       "dependencies": {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "netlify-cli",
   "description": "Netlify command line tool",
-  "version": "8.5.0",
+  "version": "8.6.0",
   "author": "Netlify Inc.",
   "contributors": [
     "Mathias Biilmann <matt@netlify.com> (https://twitter.com/biilmann)",

package/src/commands/env/env-migrate.js

@@ -0,0 +1,108 @@
+// @ts-check
+
+const { isEmpty } = require('lodash')
+
+const { chalk, error: logError, log } = require('../../utils')
+
+const safeGetSite = async (api, siteId) => {
+  try {
+    const data = await api.getSite({ siteId })
+    return { data }
+  } catch (error) {
+    return { error }
+  }
+}
+
+/**
+ * The env:migrate command
+ * @param {string} siteIdA Site (From)
+ * @param {string} siteIdB Site (To)
+ * @param {import('commander').OptionValues} options
+ * @param {import('../base-command').BaseCommand} command
+ * @returns {Promise<boolean>}
+ */
+const envMigrate = async (options, command) => {
+  const { api, site } = command.netlify
+
+  if (!site.id && !options.from) {
+    log(
+      'Please include the source site Id as the `--from` option, or run `netlify link` to link this folder to a Netlify site',
+    )
+    return false
+  }
+
+  const siteId = {
+    from: options.from || site.id,
+    to: options.to,
+  }
+
+  const [{ data: siteFrom, error: errorFrom }, { data: siteTo, error: errorTo }] = await Promise.all([
+    safeGetSite(api, siteId.from),
+    safeGetSite(api, siteId.to),
+  ])
+
+  if (errorFrom) {
+    logError(`Can't find site with id ${chalk.bold(siteId.from)}. Please make sure the site exists.`)
+    return false
+  }
+
+  if (errorTo) {
+    logError(`Can't find site with id ${chalk.bold(siteId.to)}. Please make sure the site exists.`)
+    return false
+  }
+
+  const [
+    {
+      build_settings: { env: envFrom = {} },
+    },
+    {
+      build_settings: { env: envTo = {} },
+    },
+  ] = [siteFrom, siteTo]
+
+  if (isEmpty(envFrom)) {
+    log(`${chalk.greenBright(siteFrom.name)} has no environment variables, nothing to migrate`)
+    return false
+  }
+
+  // Merge from site A to site B
+  const mergedEnv = {
+    ...envTo,
+    ...envFrom,
+  }
+
+  // Apply environment variable updates
+  await api.updateSite({
+    siteId: siteId.to,
+    body: {
+      build_settings: {
+        env: mergedEnv,
+      },
+    },
+  })
+
+  log(
+    `Successfully migrated environment variables from ${chalk.greenBright(siteFrom.name)} to ${chalk.greenBright(
+      siteTo.name,
+    )}`,
+  )
+}
+
+/**
+ * Creates the `netlify env:migrate` command
+ * @param {import('../base-command').BaseCommand} program
+ * @returns
+ */
+const createEnvMigrateCommand = (program) =>
+  program
+    .command('env:migrate')
+    .option('-f, --from <from>', 'Site ID (From)')
+    .requiredOption('-t, --to <to>', 'Site ID (To)')
+    .description(`Migrate environment variables from one site to another`)
+    .addExamples([
+      'netlify env:migrate --to <to-site-id>',
+      'netlify env:migrate --to <to-site-id> --from <from-site-id>',
+    ])
+    .action(envMigrate)
+
+module.exports = { createEnvMigrateCommand }

package/src/commands/env/env.js

@@ -2,6 +2,7 @@
 const { createEnvGetCommand } = require('./env-get')
 const { createEnvImportCommand } = require('./env-import')
 const { createEnvListCommand } = require('./env-list')
+const { createEnvMigrateCommand } = require('./env-migrate')
 const { createEnvSetCommand } = require('./env-set')
 const { createEnvUnsetCommand } = require('./env-unset')
 
@@ -25,6 +26,7 @@ const createEnvCommand = (program) => {
   createEnvListCommand(program)
   createEnvSetCommand(program)
   createEnvUnsetCommand(program)
+  createEnvMigrateCommand(program)
 
   return program
     .command('env')
@@ -35,6 +37,7 @@ const createEnvCommand = (program) => {
       'netlify env:set VAR_NAME value',
       'netlify env:unset VAR_NAME',
       'netlify env:import fileName',
+      'netlify env:migrate --to <to-site-id>',
     ])
     .action(env)
 }