Merge branch 'main' into zapier-platform-major-release-17.0.0-dev

CHANGELOG.md

@@ -1,3 +1,30 @@
+## 16.3.0
+
+_released `2025-01-30`_
+
+### cli
+
+- :scroll: Update `pull` command help text to clarify `ynarxdeiH` options if file conflicts detected [#959](https://github.com/zapier/zapier-platform/pull/959)
+- :tada: Add `--overwrite-partner-changes` flag in `push` command to help reduce partner integration clobbering (currently only supported for **internal** use) [#960](https://github.com/zapier/zapier-platform/pull/960)
+
+
+## 16.2.0
+
+_released `2025-01-21`_
+
+### cli
+
+- :tada: Require `--force` flag when updating production integration version environment variables via `env:set` or `env:unset` [#942](https://github.com/zapier/zapier-platform/pull/942)
+- :tada: Run environment variable soft checks (which require user confirmation to proceed) during `promote` and `migrate` [#951](https://github.com/zapier/zapier-platform/pull/951)
+
+
+## 16.1.1
+
+_released `2025-01-13`_
+
+### cli
+
+- :bug: Fix "integration check reference" doc URL's anchor tags [#947](https://github.com/zapier/zapier-platform/pull/947)
 
 ## 16.1.0
 

example-apps/babel/package.json

@@ -21,7 +21,7 @@
   },
   "dependencies": {
     "babel-polyfill": "6.26.0",
-    "zapier-platform-core": "16.1.0"
+    "zapier-platform-core": "16.3.0"
   },
   "devDependencies": {
     "babel-cli": "6.26.0",

example-apps/basic-auth/package.json

@@ -7,7 +7,7 @@
     "test": "jest --testTimeout 10000"
   },
   "dependencies": {
-    "zapier-platform-core": "16.1.0"
+    "zapier-platform-core": "16.3.0"
   },
   "devDependencies": {
     "jest": "^25.5.3"

example-apps/callback/package.json

@@ -7,7 +7,7 @@
     "test": "jest --testTimeout 10000"
   },
   "dependencies": {
-    "zapier-platform-core": "16.1.0"
+    "zapier-platform-core": "16.3.0"
   },
   "devDependencies": {
     "jest": "^25.5.3"

example-apps/create/package.json

@@ -15,7 +15,7 @@
     "npm": ">=5.6.0"
   },
   "dependencies": {
-    "zapier-platform-core": "16.1.0"
+    "zapier-platform-core": "16.3.0"
   },
   "devDependencies": {
     "mocha": "^5.2.0",

example-apps/custom-auth/package.json

@@ -7,7 +7,7 @@
     "test": "jest --testTimeout 10000"
   },
   "dependencies": {
-    "zapier-platform-core": "16.1.0"
+    "zapier-platform-core": "16.3.0"
   },
   "devDependencies": {
     "jest": "^25.5.3"

example-apps/digest-auth/package.json

@@ -7,7 +7,7 @@
     "test": "jest --testTimeout 10000"
   },
   "dependencies": {
-    "zapier-platform-core": "16.1.0"
+    "zapier-platform-core": "16.3.0"
   },
   "devDependencies": {
     "jest": "^25.5.3"

example-apps/dynamic-dropdown/package.json

@@ -7,7 +7,7 @@
     "test": "jest --testTimeout 10000"
   },
   "dependencies": {
-    "zapier-platform-core": "16.1.0"
+    "zapier-platform-core": "16.3.0"
   },
   "devDependencies": {
     "jest": "^29.6.0"

example-apps/files/package.json

@@ -7,7 +7,7 @@
     "test": "jest --testTimeout 10000"
   },
   "dependencies": {
-    "zapier-platform-core": "16.1.0",
+    "zapier-platform-core": "16.3.0",
     "form-data": "4.0.0"
   },
   "devDependencies": {

example-apps/github/package.json

@@ -15,7 +15,7 @@
     "npm": ">=5.6.0"
   },
   "dependencies": {
-    "zapier-platform-core": "16.1.0"
+    "zapier-platform-core": "16.3.0"
   },
   "devDependencies": {
     "jest": "^26.6.3",

example-apps/middleware/package.json

@@ -16,7 +16,7 @@
   },
   "dependencies": {
     "lodash": "4.17.19",
-    "zapier-platform-core": "16.1.0"
+    "zapier-platform-core": "16.3.0"
   },
   "devDependencies": {
     "mocha": "^5.2.0",

example-apps/minimal/package.json

@@ -7,7 +7,7 @@
     "test": "jest --testTimeout 10000"
   },
   "dependencies": {
-    "zapier-platform-core": "16.1.0"
+    "zapier-platform-core": "16.3.0"
   },
   "devDependencies": {
     "jest": "^25.5.3"

example-apps/oauth1-trello/package.json

@@ -7,7 +7,7 @@
     "test": "jest --testTimeout 10000"
   },
   "dependencies": {
-    "zapier-platform-core": "16.1.0"
+    "zapier-platform-core": "16.3.0"
   },
   "devDependencies": {
     "jest": "^25.5.3"

example-apps/oauth1-tumblr/package.json

@@ -15,7 +15,7 @@
     "npm": ">=5.6.0"
   },
   "dependencies": {
-    "zapier-platform-core": "16.1.0"
+    "zapier-platform-core": "16.3.0"
   },
   "devDependencies": {
     "mocha": "^5.2.0",

example-apps/oauth1-twitter/package.json

@@ -15,7 +15,7 @@
     "npm": ">=5.6.0"
   },
   "dependencies": {
-    "zapier-platform-core": "16.1.0"
+    "zapier-platform-core": "16.3.0"
   },
   "devDependencies": {
     "mocha": "^5.2.0",

example-apps/oauth2/package.json

@@ -7,7 +7,7 @@
     "test": "jest --testTimeout 10000"
   },
   "dependencies": {
-    "zapier-platform-core": "16.1.0"
+    "zapier-platform-core": "16.3.0"
   },
   "devDependencies": {
     "jest": "^25.5.3"

example-apps/onedrive/package.json

@@ -22,7 +22,7 @@
     "content-disposition": "0.5.2",
     "lodash": "4.17.11",
     "node-fetch": "1.7.1",
-    "zapier-platform-core": "16.1.0"
+    "zapier-platform-core": "16.3.0"
   },
   "devDependencies": {
     "eslint": "3.19.0",

example-apps/resource/package.json

@@ -15,7 +15,7 @@
     "npm": ">=5.6.0"
   },
   "dependencies": {
-    "zapier-platform-core": "16.1.0"
+    "zapier-platform-core": "16.3.0"
   },
   "devDependencies": {
     "mocha": "^5.2.0",

example-apps/rest-hooks/package.json

@@ -15,7 +15,7 @@
     "npm": ">=5.6.0"
   },
   "dependencies": {
-    "zapier-platform-core": "16.1.0"
+    "zapier-platform-core": "16.3.0"
   },
   "devDependencies": {
     "mocha": "^5.2.0",

example-apps/search-or-create/package.json

@@ -7,7 +7,7 @@
     "test": "jest --testTimeout 10000"
   },
   "dependencies": {
-    "zapier-platform-core": "16.1.0"
+    "zapier-platform-core": "16.3.0"
   },
   "devDependencies": {
     "jest": "^25.5.3"

example-apps/search/package.json

@@ -15,7 +15,7 @@
     "npm": ">=5.6.0"
   },
   "dependencies": {
-    "zapier-platform-core": "16.1.0"
+    "zapier-platform-core": "16.3.0"
   },
   "devDependencies": {
     "mocha": "^5.2.0",

example-apps/session-auth/package.json

@@ -7,7 +7,7 @@
     "test": "jest --testTimeout 10000"
   },
   "dependencies": {
-    "zapier-platform-core": "16.1.0"
+    "zapier-platform-core": "16.3.0"
   },
   "devDependencies": {
     "jest": "^25.5.3"

example-apps/trigger/package.json

@@ -15,7 +15,7 @@
     "npm": ">=5.6.0"
   },
   "dependencies": {
-    "zapier-platform-core": "16.1.0"
+    "zapier-platform-core": "16.3.0"
   },
   "devDependencies": {
     "mocha": "^5.2.0",

example-apps/typescript/package.json

@@ -10,7 +10,7 @@
     "_zapier-build": "npm run build"
   },
   "dependencies": {
-    "zapier-platform-core": "16.1.0"
+    "zapier-platform-core": "16.3.0"
   },
   "devDependencies": {
     "rimraf": "^5.0.10",

packages/cli/docs/cli.md

@@ -225,6 +225,7 @@ resources convert and relate to different actions.
 * `key-value pairs...` | The key-value pairs to set. Keys are case-insensitive. Each pair should be space separated and pairs should be separated by an `=`. For example: `A=123 B=456`
 
 **Flags**
+* `-f, --force` | Force the update of environment variables regardless if the app version is production or not. Use with caution.
 * `-d, --debug` | Show extra debugging output.
 
 **Examples**
@@ -242,6 +243,7 @@ resources convert and relate to different actions.
 * `keys...` | The keys to unset. Keys are case-insensitive.
 
 **Flags**
+* `-f, --force` | Force the update of environment variables regardless if the app version is production or not. Use with caution.
 * `-d, --debug` | Show extra debugging output.
 
 **Examples**
@@ -512,6 +514,7 @@ You cannot pass both `--user` and `--account`.
 **Flags**
 * `--user` | Migrates all of a users' Private Zaps within all accounts for which the specified user is a member
 * `--account` | Migrates all of a users' Zaps, Private & Shared, within all accounts for which the specified user is a member
+* `-y, --yes` | Automatically answer "yes" to any prompts. Useful if you want to avoid interactive prompts to run this command in CI.
 * `-d, --debug` | Show extra debugging output.
 
 **Examples**

packages/cli/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zapier-platform-cli",
-  "version": "16.1.0",
+  "version": "16.3.0",
   "description": "The CLI for managing integrations in Zapier Developer Platform.",
   "repository": "zapier/zapier-platform",
   "homepage": "https://platform.zapier.com/",

packages/cli/src/constants.js

@@ -42,7 +42,7 @@ const PACKAGE_VERSION = packageJson.version;
 const UPDATE_NOTIFICATION_INTERVAL = 1000 * 60 * 60 * 24 * 7; // one week
 
 const CHECK_REF_DOC_LINK =
-  'https://docs.zapier.com/platform/publish/integration-checks-reference#integration-check-reference';
+  'https://docs.zapier.com/platform/publish/integration-checks-reference';
 
 const ISSUES_URL =
   'https://github.com/zapier/zapier-platform/issues/new/choose';

packages/cli/src/generators/pull.js

@@ -24,7 +24,10 @@ module.exports = class PullGenerator extends Generator {
         name: 'confirm',
         message: `Warning: You are about to overwrite existing files.
 
-Before proceeding, please make sure you have saved your work. Consider creating a backup or saving your current state in a git branch. During the process, you may abort anytime by pressing 'x'.
+Before proceeding, please make sure you have saved your work. Consider creating a backup or saving your current state in a git branch.
+
+If presented with a series of options ('ynarxdeiH'), you may
+press Enter to view more details about each option. For example, 'x' will abort the process.
 
 Do you want to continue?`,
         default: false,

packages/cli/src/oclif/commands/env/set.js

@@ -1,4 +1,4 @@
-const { Args } = require('@oclif/core');
+const { Args, Flags } = require('@oclif/core');
 const { cyan } = require('colors/safe');
 const { omit } = require('lodash');
 
@@ -45,21 +45,30 @@ class SetEnvCommand extends BaseCommand {
     }
 
     const url = `/apps/${app.id}/versions/${version}/multi-environment`;
+    const requestOptions = {
+      body: payload,
+      method: 'POST',
+    };
+
+    if (this.flags.force) {
+      requestOptions.extraHeaders = {
+        'X-Force-Env-Var-Update': 'true',
+      };
+    }
 
     try {
-      // currently, this returns nothing
-      await callAPI(
-        url,
-        {
-          body: payload,
-          method: 'POST',
-        },
-        true,
-      );
+      await callAPI(url, requestOptions, true);
 
       this.log(successMessage(version));
       this.logJSON(payload);
     } catch (e) {
+      if (e.status === 409) {
+        this.error(
+          `App version ${version} is the production version. Are you sure you want to set potentially live environment variables?` +
+            ` If so, run this command again with the --force flag.`,
+        );
+      }
+
       // comes back as json: { errors: [ 'The following keys failed to update: 3QER, 4WER' ] },
       const failedKeys = e.json.errors[0].split('update: ')[1].split(', ');
       const successfulResult = omit(payload, failedKeys);
@@ -85,7 +94,15 @@ SetEnvCommand.args = {
       'The key-value pairs to set. Keys are case-insensitive. Each pair should be space separated and pairs should be separated by an `=`. For example: `A=123 B=456`',
   }),
 };
-SetEnvCommand.flags = buildFlags();
+SetEnvCommand.flags = buildFlags({
+  commandFlags: {
+    force: Flags.boolean({
+      char: 'f',
+      description:
+        'Force the update of environment variables regardless if the app version is production or not. Use with caution.',
+    }),
+  },
+});
 SetEnvCommand.description = `Set environment variables for a version.`;
 SetEnvCommand.examples = [`zapier env:set 1.2.3 SECRET=12345 OTHER=4321`];
 SetEnvCommand.strict = false;