Merge pull request #779 from zapier/migrate_command

PLATSUP-1042_migrate_command_update

docs/cli.html

@@ -791,14 +791,14 @@ <h2 id="migrate">migrate</h2>
     <div class="col-md-5 col-sm-12 col-height  docs-primary">
       <blockquote>
 <p>Migrate a percentage of users or a single user from one version of your integration to another.</p>
-</blockquote><p><strong>Usage</strong>: <code>zapier migrate FROMVERSION TOVERSION [PERCENT]</code></p><p>Start a migration to move users between different versions of your integration. You may also &quot;revert&quot; by simply swapping the from/to verion strings in the command line arguments (i.e. <code>zapier migrate 1.0.1 1.0.0</code>).</p><p><strong>Only use this command to migrate users between non-breaking versions, use <code>zapier deprecate</code> if you have breaking changes!</strong></p><p>Migration time varies based on the number of affected Zaps. Be patient and check <code>zapier jobs</code> to track the status. Or use <code>zapier history</code> if you want to see older jobs.</p><p>Since a migration is only for non-breaking changes, users are not emailed about the update/migration. It will be a transparent process for them.</p><p>We recommend migrating a small subset of users first, via the percent argument, then watching error logs of the new version for any sort of odd behavior. When you feel confident there are no bugs, go ahead and migrate everyone. If you see unexpected errors, you can revert.</p><p>You can migrate a specific user&apos;s Zaps by using <code>--user</code> (i.e. <code>zapier migrate 1.0.0 1.0.1 [email protected]</code>). This will migrate Zaps in any account the user is a member of where the following criteria is met.</p><ul>
-<li><p>The Zap is owned by the user.</p>
+</blockquote><p><strong>Usage</strong>: <code>zapier migrate FROMVERSION TOVERSION [PERCENT]</code></p><p>Start a migration to move users between different versions of your integration. You may also &quot;revert&quot; by simply swapping the from/to verion strings in the command line arguments (i.e. <code>zapier migrate 1.0.1 1.0.0</code>).</p><p><strong>Only use this command to migrate users between non-breaking versions, use <code>zapier deprecate</code> if you have breaking changes!</strong></p><p>Migration time varies based on the number of affected Zaps. Be patient and check <code>zapier jobs</code> to track the status. Or use <code>zapier history</code> if you want to see older jobs.</p><p>Since a migration is only for non-breaking changes, users are not emailed about the update/migration. It will be a transparent process for them.</p><p>We recommend migrating a small subset of users first, via the percent argument, then watching error logs of the new version for any sort of odd behavior. When you feel confident there are no bugs, go ahead and migrate everyone. If you see unexpected errors, you can revert.</p><p>You can migrate a specific user&apos;s Zaps by using <code>--user</code> (i.e. <code>zapier migrate 1.0.0 1.0.1 [email protected]</code>). This will migrate Zaps that are private for that user. Zaps that are</p><ul>
+<li><p><a href="https://help.zapier.com/hc/en-us/articles/8496277647629">shared across the team</a>,</p>
 </li>
-<li><p>The Zap is not shared.</p>
+<li><p><a href="https://help.zapier.com/hc/en-us/articles/8496326497037-Share-app-connections-with-your-team">shared app connections</a>, or</p>
 </li>
-<li><p>The integration auth used is not shared.</p>
+<li><p>in a <a href="https://help.zapier.com/hc/en-us/articles/22330977078157-Collaborate-with-members-of-your-Team-or-Company-account">team/company account</a></p>
 </li>
-</ul><p>Alternatively, you can pass the <code>--account</code> flag, (i.e. <code>zapier migrate 1.0.0 1.0.1 [email protected]</code>). This will migrate all users&apos; Zaps, Private &amp; Shared, within all accounts for which the specified user is a member.</p><p><strong>The <code>--account</code> flag should be used cautiously as it can break shared Zaps for other users in Team or Company accounts.</strong></p><p>You cannot pass both <code>PERCENT</code> and <code>--user</code> or <code>--account</code>.</p><p>You cannot pass both <code>--user</code> and <code>--account</code>.</p><p><strong>Arguments</strong></p><ul>
+</ul><p>will <strong>not</strong> be migrated.</p><p>Alternatively, you can pass the <code>--account</code> flag, (i.e. <code>zapier migrate 1.0.0 1.0.1 [email protected]</code>). This will migrate all Zaps owned by the user, Private &amp; Shared, within all accounts for which the specified user is a member.</p><p><strong>The <code>--account</code> flag should be used cautiously as it can break shared Zaps for other users in Team or Enterprise accounts.</strong></p><p>You cannot pass both <code>PERCENT</code> and <code>--user</code> or <code>--account</code>.</p><p>You cannot pass both <code>--user</code> and <code>--account</code>.</p><p><strong>Arguments</strong></p><ul>
 <li>(required) <code>fromVersion</code> | The version FROM which to migrate users.</li>
 <li>(required) <code>toVersion</code> | The version TO which to migrate users.</li>
 <li><code>percent</code> | Percentage (between 1 and 100) of users to migrate.</li>

docs/cli.md

@@ -352,17 +352,19 @@ Since a migration is only for non-breaking changes, users are not emailed about
 
 We recommend migrating a small subset of users first, via the percent argument, then watching error logs of the new version for any sort of odd behavior. When you feel confident there are no bugs, go ahead and migrate everyone. If you see unexpected errors, you can revert.
 
-You can migrate a specific user's Zaps by using `--user` (i.e. `zapier migrate 1.0.0 1.0.1 [email protected]`). This will migrate Zaps in any account the user is a member of where the following criteria is met.
+You can migrate a specific user's Zaps by using `--user` (i.e. `zapier migrate 1.0.0 1.0.1 [email protected]`). This will migrate Zaps that are private for that user. Zaps that are
 
-  - The Zap is owned by the user.
+  - [shared across the team](https://help.zapier.com/hc/en-us/articles/8496277647629),
 
-  - The Zap is not shared.
+  - [shared app connections](https://help.zapier.com/hc/en-us/articles/8496326497037-Share-app-connections-with-your-team), or
 
-  - The integration auth used is not shared.
+  - in a [team/company account](https://help.zapier.com/hc/en-us/articles/22330977078157-Collaborate-with-members-of-your-Team-or-Company-account)
 
-Alternatively, you can pass the `--account` flag, (i.e. `zapier migrate 1.0.0 1.0.1 [email protected]`). This will migrate all users' Zaps, Private & Shared, within all accounts for which the specified user is a member.
+will **not** be migrated.
 
-**The `--account` flag should be used cautiously as it can break shared Zaps for other users in Team or Company accounts.**
+Alternatively, you can pass the `--account` flag, (i.e. `zapier migrate 1.0.0 1.0.1 [email protected]`). This will migrate all Zaps owned by the user, Private & Shared, within all accounts for which the specified user is a member.
+
+**The `--account` flag should be used cautiously as it can break shared Zaps for other users in Team or Enterprise accounts.**
 
 You cannot pass both `PERCENT` and `--user` or `--account`.
 

packages/cli/docs/cli.html

@@ -791,14 +791,14 @@ <h2 id="migrate">migrate</h2>
     <div class="col-md-5 col-sm-12 col-height  docs-primary">
       <blockquote>
 <p>Migrate a percentage of users or a single user from one version of your integration to another.</p>
-</blockquote><p><strong>Usage</strong>: <code>zapier migrate FROMVERSION TOVERSION [PERCENT]</code></p><p>Start a migration to move users between different versions of your integration. You may also &quot;revert&quot; by simply swapping the from/to verion strings in the command line arguments (i.e. <code>zapier migrate 1.0.1 1.0.0</code>).</p><p><strong>Only use this command to migrate users between non-breaking versions, use <code>zapier deprecate</code> if you have breaking changes!</strong></p><p>Migration time varies based on the number of affected Zaps. Be patient and check <code>zapier jobs</code> to track the status. Or use <code>zapier history</code> if you want to see older jobs.</p><p>Since a migration is only for non-breaking changes, users are not emailed about the update/migration. It will be a transparent process for them.</p><p>We recommend migrating a small subset of users first, via the percent argument, then watching error logs of the new version for any sort of odd behavior. When you feel confident there are no bugs, go ahead and migrate everyone. If you see unexpected errors, you can revert.</p><p>You can migrate a specific user&apos;s Zaps by using <code>--user</code> (i.e. <code>zapier migrate 1.0.0 1.0.1 [email protected]</code>). This will migrate Zaps in any account the user is a member of where the following criteria is met.</p><ul>
-<li><p>The Zap is owned by the user.</p>
+</blockquote><p><strong>Usage</strong>: <code>zapier migrate FROMVERSION TOVERSION [PERCENT]</code></p><p>Start a migration to move users between different versions of your integration. You may also &quot;revert&quot; by simply swapping the from/to verion strings in the command line arguments (i.e. <code>zapier migrate 1.0.1 1.0.0</code>).</p><p><strong>Only use this command to migrate users between non-breaking versions, use <code>zapier deprecate</code> if you have breaking changes!</strong></p><p>Migration time varies based on the number of affected Zaps. Be patient and check <code>zapier jobs</code> to track the status. Or use <code>zapier history</code> if you want to see older jobs.</p><p>Since a migration is only for non-breaking changes, users are not emailed about the update/migration. It will be a transparent process for them.</p><p>We recommend migrating a small subset of users first, via the percent argument, then watching error logs of the new version for any sort of odd behavior. When you feel confident there are no bugs, go ahead and migrate everyone. If you see unexpected errors, you can revert.</p><p>You can migrate a specific user&apos;s Zaps by using <code>--user</code> (i.e. <code>zapier migrate 1.0.0 1.0.1 [email protected]</code>). This will migrate Zaps that are private for that user. Zaps that are</p><ul>
+<li><p><a href="https://help.zapier.com/hc/en-us/articles/8496277647629">shared across the team</a>,</p>
 </li>
-<li><p>The Zap is not shared.</p>
+<li><p><a href="https://help.zapier.com/hc/en-us/articles/8496326497037-Share-app-connections-with-your-team">shared app connections</a>, or</p>
 </li>
-<li><p>The integration auth used is not shared.</p>
+<li><p>in a <a href="https://help.zapier.com/hc/en-us/articles/22330977078157-Collaborate-with-members-of-your-Team-or-Company-account">team/company account</a></p>
 </li>
-</ul><p>Alternatively, you can pass the <code>--account</code> flag, (i.e. <code>zapier migrate 1.0.0 1.0.1 [email protected]</code>). This will migrate all users&apos; Zaps, Private &amp; Shared, within all accounts for which the specified user is a member.</p><p><strong>The <code>--account</code> flag should be used cautiously as it can break shared Zaps for other users in Team or Company accounts.</strong></p><p>You cannot pass both <code>PERCENT</code> and <code>--user</code> or <code>--account</code>.</p><p>You cannot pass both <code>--user</code> and <code>--account</code>.</p><p><strong>Arguments</strong></p><ul>
+</ul><p>will <strong>not</strong> be migrated.</p><p>Alternatively, you can pass the <code>--account</code> flag, (i.e. <code>zapier migrate 1.0.0 1.0.1 [email protected]</code>). This will migrate all Zaps owned by the user, Private &amp; Shared, within all accounts for which the specified user is a member.</p><p><strong>The <code>--account</code> flag should be used cautiously as it can break shared Zaps for other users in Team or Enterprise accounts.</strong></p><p>You cannot pass both <code>PERCENT</code> and <code>--user</code> or <code>--account</code>.</p><p>You cannot pass both <code>--user</code> and <code>--account</code>.</p><p><strong>Arguments</strong></p><ul>
 <li>(required) <code>fromVersion</code> | The version FROM which to migrate users.</li>
 <li>(required) <code>toVersion</code> | The version TO which to migrate users.</li>
 <li><code>percent</code> | Percentage (between 1 and 100) of users to migrate.</li>

packages/cli/docs/cli.md

@@ -352,17 +352,19 @@ Since a migration is only for non-breaking changes, users are not emailed about
 
 We recommend migrating a small subset of users first, via the percent argument, then watching error logs of the new version for any sort of odd behavior. When you feel confident there are no bugs, go ahead and migrate everyone. If you see unexpected errors, you can revert.
 
-You can migrate a specific user's Zaps by using `--user` (i.e. `zapier migrate 1.0.0 1.0.1 [email protected]`). This will migrate Zaps in any account the user is a member of where the following criteria is met.
+You can migrate a specific user's Zaps by using `--user` (i.e. `zapier migrate 1.0.0 1.0.1 [email protected]`). This will migrate Zaps that are private for that user. Zaps that are
 
-  - The Zap is owned by the user.
+  - [shared across the team](https://help.zapier.com/hc/en-us/articles/8496277647629),
 
-  - The Zap is not shared.
+  - [shared app connections](https://help.zapier.com/hc/en-us/articles/8496326497037-Share-app-connections-with-your-team), or
 
-  - The integration auth used is not shared.
+  - in a [team/company account](https://help.zapier.com/hc/en-us/articles/22330977078157-Collaborate-with-members-of-your-Team-or-Company-account)
 
-Alternatively, you can pass the `--account` flag, (i.e. `zapier migrate 1.0.0 1.0.1 [email protected]`). This will migrate all users' Zaps, Private & Shared, within all accounts for which the specified user is a member.
+will **not** be migrated.
 
-**The `--account` flag should be used cautiously as it can break shared Zaps for other users in Team or Company accounts.**
+Alternatively, you can pass the `--account` flag, (i.e. `zapier migrate 1.0.0 1.0.1 [email protected]`). This will migrate all Zaps owned by the user, Private & Shared, within all accounts for which the specified user is a member.
+
+**The `--account` flag should be used cautiously as it can break shared Zaps for other users in Team or Enterprise accounts.**
 
 You cannot pass both `PERCENT` and `--user` or `--account`.
 

packages/cli/src/oclif/commands/migrate.js

@@ -147,15 +147,17 @@ Since a migration is only for non-breaking changes, users are not emailed about
 
 We recommend migrating a small subset of users first, via the percent argument, then watching error logs of the new version for any sort of odd behavior. When you feel confident there are no bugs, go ahead and migrate everyone. If you see unexpected errors, you can revert.
 
-You can migrate a specific user's Zaps by using \`--user\` (i.e. \`zapier migrate 1.0.0 1.0.1 [email protected]\`). This will migrate Zaps in any account the user is a member of where the following criteria is met.
+You can migrate a specific user's Zaps by using \`--user\` (i.e. \`zapier migrate 1.0.0 1.0.1 [email protected]\`). This will migrate Zaps that are private for that user. Zaps that are
 
-  - The Zap is owned by the user.
-  - The Zap is not shared.
-  - The integration auth used is not shared.
+  - [shared across the team](https://help.zapier.com/hc/en-us/articles/8496277647629),
+  - [shared app connections](https://help.zapier.com/hc/en-us/articles/8496326497037-Share-app-connections-with-your-team), or
+  - in a [team/company account](https://help.zapier.com/hc/en-us/articles/22330977078157-Collaborate-with-members-of-your-Team-or-Company-account)
 
-Alternatively, you can pass the \`--account\` flag, (i.e. \`zapier migrate 1.0.0 1.0.1 [email protected]\`). This will migrate all users' Zaps, Private & Shared, within all accounts for which the specified user is a member.
+will **not** be migrated.
 
-**The \`--account\` flag should be used cautiously as it can break shared Zaps for other users in Team or Company accounts.**
+Alternatively, you can pass the \`--account\` flag, (i.e. \`zapier migrate 1.0.0 1.0.1 [email protected]\`). This will migrate all Zaps owned by the user, Private & Shared, within all accounts for which the specified user is a member.
+
+**The \`--account\` flag should be used cautiously as it can break shared Zaps for other users in Team or Enterprise accounts.**
 
 You cannot pass both \`PERCENT\` and \`--user\` or \`--account\`.