-
Notifications
You must be signed in to change notification settings - Fork 191
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
5 changed files
with
15 additions
and
15 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -790,15 +790,15 @@ <h2 id="migrate">migrate</h2> | |
| <div class="row-height"> | ||
| <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 "revert" 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'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> | ||
| <p>Migrate a percentage of users or a single user from a 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 "revert" by simply swapping the from/to version 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'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> | ||
| </li> | ||
| <li><p>The Zap is not shared.</p> | ||
| </li> | ||
| <li><p>The integration auth used is not shared.</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' Zaps, Private & 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>When you , you can also pass the <code>--include-all-compatible-versions</code> flag to migrate all older compatible versions of the integration. For example, if you have versions 1.0.0, 1.1.0 and 1.2.0 which you would like to migrate to version 2.0.0, you can run the migrate command with <code>fromVersion</code> set to 1.2.0 and use the <code>--include-all-compatible-versions</code> flag.</p><p><strong>The <code>--include-all-compatible-versions</code> flag should be used cautiously as it is a bulk operation that will possibly affect more than just one version. It also only supports forward migrations; rolling back to a previous version would require individual migrations.</strong></p><p><strong>Arguments</strong></p><ul> | ||
| </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' Zaps, Private & 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>If you want to migrate more than one version to another specific version, instead of running many individual commands, you can evaluate using the <code>--include-all-compatible-versions</code> flag. This would migrate all compatible versions of the integration besides the specified "from" version. For example, if you have versions 1.0.0, 1.0.5 and 1.1.0 which you would like to migrate to version 1.2.0, you can run the migrate command with "from" version set to 1.1.0 and use the <code>--include-all-compatible-versions</code> flag (i.e. <code>zapier migrate 1.1.0 1.2.0 --include-all-compatible-versions</code>). This would migrate versions 1.0.0, 1.0.5 and 1.1.0 to version 1.2.0.</p><p><strong>The <code>--include-all-compatible-versions</code> flag should be used cautiously as it is a bulk operation that will possibly affect more than just one version. It also only supports forward migrations; rolling back to a previous version would require individual migrations.</strong></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> | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -790,15 +790,15 @@ <h2 id="migrate">migrate</h2> | |
| <div class="row-height"> | ||
| <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 "revert" 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'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> | ||
| <p>Migrate a percentage of users or a single user from a 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 "revert" by simply swapping the from/to version 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'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> | ||
| </li> | ||
| <li><p>The Zap is not shared.</p> | ||
| </li> | ||
| <li><p>The integration auth used is not shared.</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' Zaps, Private & 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>When you , you can also pass the <code>--include-all-compatible-versions</code> flag to migrate all older compatible versions of the integration. For example, if you have versions 1.0.0, 1.1.0 and 1.2.0 which you would like to migrate to version 2.0.0, you can run the migrate command with <code>fromVersion</code> set to 1.2.0 and use the <code>--include-all-compatible-versions</code> flag.</p><p><strong>The <code>--include-all-compatible-versions</code> flag should be used cautiously as it is a bulk operation that will possibly affect more than just one version. It also only supports forward migrations; rolling back to a previous version would require individual migrations.</strong></p><p><strong>Arguments</strong></p><ul> | ||
| </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' Zaps, Private & 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>If you want to migrate more than one version to another specific version, instead of running many individual commands, you can evaluate using the <code>--include-all-compatible-versions</code> flag. This would migrate all compatible versions of the integration besides the specified "from" version. For example, if you have versions 1.0.0, 1.0.5 and 1.1.0 which you would like to migrate to version 1.2.0, you can run the migrate command with "from" version set to 1.1.0 and use the <code>--include-all-compatible-versions</code> flag (i.e. <code>zapier migrate 1.1.0 1.2.0 --include-all-compatible-versions</code>). This would migrate versions 1.0.0, 1.0.5 and 1.1.0 to version 1.2.0.</p><p><strong>The <code>--include-all-compatible-versions</code> flag should be used cautiously as it is a bulk operation that will possibly affect more than just one version. It also only supports forward migrations; rolling back to a previous version would require individual migrations.</strong></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> | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -168,9 +168,9 @@ MigrateCommand.examples = [ | |
| 'zapier migrate 2.0.0 2.0.1 [email protected]', | ||
| 'zapier migrate 2.4.0 2.5.0 --include-all-compatible-versions', | ||
| ]; | ||
| MigrateCommand.description = `Migrate a percentage of users or a single user from one version of your integration to another. | ||
| MigrateCommand.description = `Migrate a percentage of users or a single user from a version of your integration to another. | ||
| Start a migration to move users between different versions of your integration. You may also "revert" by simply swapping the from/to verion strings in the command line arguments (i.e. \`zapier migrate 1.0.1 1.0.0\`). | ||
| Start a migration to move users between different versions of your integration. You may also "revert" by simply swapping the from/to version strings in the command line arguments (i.e. \`zapier migrate 1.0.1 1.0.0\`). | ||
| **Only use this command to migrate users between non-breaking versions, use \`zapier deprecate\` if you have breaking changes!** | ||
|
|
@@ -194,7 +194,7 @@ You cannot pass both \`PERCENT\` and \`--user\` or \`--account\`. | |
| You cannot pass both \`--user\` and \`--account\`. | ||
| When you , you can also pass the \`--include-all-compatible-versions\` flag to migrate all older compatible versions of the integration. For example, if you have versions 1.0.0, 1.1.0 and 1.2.0 which you would like to migrate to version 2.0.0, you can run the migrate command with \`fromVersion\` set to 1.2.0 and use the \`--include-all-compatible-versions\` flag. | ||
| If you want to migrate more than one version to another specific version, instead of running many individual commands, you can evaluate using the \`--include-all-compatible-versions\` flag. This would migrate all compatible versions of the integration besides the specified "from" version. For example, if you have versions 1.0.0, 1.0.5 and 1.1.0 which you would like to migrate to version 1.2.0, you can run the migrate command with "from" version set to 1.1.0 and use the \`--include-all-compatible-versions\` flag (i.e. \`zapier migrate 1.1.0 1.2.0 --include-all-compatible-versions\`). This would migrate versions 1.0.0, 1.0.5 and 1.1.0 to version 1.2.0. | ||
| **The \`--include-all-compatible-versions\` flag should be used cautiously as it is a bulk operation that will possibly affect more than just one version. It also only supports forward migrations; rolling back to a previous version would require individual migrations.** | ||
| `; | ||
|
|
||