Merge pull request #468 from twilio/changelog-update

Changelog update

Author: ktalebian

changelog/v4.md

@@ -1,6 +1,8 @@
-## 4.x - Beta
+## 4.0.0 (May 17th, 2021)
 
-Create Flex Plugin 4.x uses the [Twilio Flex Plugins API](https://www.twilio.com/docs/flex/plugins/api) to manage your Flex Plugins, create versions, and define which plugins the Flex UI will load during initialization via an API.  
+Refer to [Twilio Flex Docs](https://www.twilio.com/docs/flex/developer/plugins/cli) to be up-to-date with the latest features being built on the CLI.
+
+Create Flex Plugin 4.0.0 uses the [Twilio Flex Plugins API](https://www.twilio.com/docs/flex/plugins/api) to manage your Flex Plugins, create versions, and define which plugins the Flex UI will load during initialization via an API.  
 
 It completely removes the dependency on `react-scripts` and instead uses native Webpack to build and serve your plugins locally.
 
@@ -22,6 +24,8 @@ $ twilio flex:plugins:upgrade-plugin --install
 
 This script should automatically upgrade your plugin to the latest version. 
 
+## Manual Upgrade
+
 To manually upgrade to version 4.x, modify your `package.json`:
 
 ```json
@@ -30,7 +34,7 @@ To manually upgrade to version 4.x, modify your `package.json`:
     "postinstall": "flex-plugin pre-script-check"
   },
   "dependencies": {
-    "flex-plugin-scripts": "^4.2.7-beta.0",
+    "flex-plugin-scripts": "^4.0.0",
     "react": "16.5.2",
     "react-dom": "16.5.2"
   },
@@ -39,9 +43,6 @@ To manually upgrade to version 4.x, modify your `package.json`:
   }
 }
 ```
-
-Please use `npm view flex-plugin-scripts dist-tags.beta` to find the current latest beta version and use that instead of `4.2.7-beta.0` as show above.
-
 If you are currently using `craco.config.js`, please refer to the next section [Breaking Changes](#breaking-changes) on migrating it.
 
 You may also need to update your `public/appConfig.js` and update the `pluginService`:
@@ -78,7 +79,7 @@ module.exports = (config, { isProd, isDev, isTest }) => {
 
 Upgrading from v1/v2 will, unfortunately, include a period of downtime. Your contact-center will either have the same plugin running twice or the plugin missing from it (this period will only be at most 1 minute long). Therefore, it is recommended to do this migration when you don't expect high usage of your contact center.
 
-First, upgrade the plugin locally using `$ twilio flex:plugins:upgrade --beta` from the guide above.  
+First, upgrade the plugin locally using `$ twilio flex:plugins:upgrade` from the guide above.  
 
 Next, decide if you prefer to have the plugin show twice or not at all. You'll need to deploy/release using the CLI and delete the plugin from [Twilio Console Assets](https://www.twilio.com/console/assets). Unfortunately, these two steps must be done manually. 
 
@@ -88,7 +89,7 @@ It is recommended that you `deploy` (using `twilio flex:plugins:deploy`) your pl
 
 Upgrading from v3 is simple and has no downtime. 
 
-1. Upgrade the plugin locally using `$ twilio flex:plugins:upgrade --beta` from the guide above.  
+1. Upgrade the plugin locally using `$ twilio flex:plugins:upgrade` from the guide above.  
 2. Deploy and register the plugin using `$ twilio flex:plugins:deploy` and `$ twilio flex:plugins:release`
 3. Remove the v0.0.0 plugin from v3 using `$ twilio flex:plugins:upgrade --cleanup`
 

packages/plugin-flex/README.md

@@ -80,7 +80,7 @@ OPTIONS
   --sid=sid                        (required) The Flex Plugin Configuration SID to archive.
 ```
 
-_See code: [dist/commands/flex/plugins/archive/configuration.js](https://github.com/twilio/flex-plugin-builder/blob/v4.9.1-beta.0/dist/commands/flex/plugins/archive/configuration.js)_
+_See code: [dist/commands/flex/plugins/archive/configuration.js](https://github.com/twilio/flex-plugin-builder/blob/v4.0.0/dist/commands/flex/plugins/archive/configuration.js)_
 
 ## `twilio flex:plugins:archive:plugin`
 
@@ -97,7 +97,7 @@ OPTIONS
   --name=name                      (required) The name of the Flex Plugin to archive.
 ```
 
-_See code: [dist/commands/flex/plugins/archive/plugin.js](https://github.com/twilio/flex-plugin-builder/blob/v4.9.1-beta.0/dist/commands/flex/plugins/archive/plugin.js)_
+_See code: [dist/commands/flex/plugins/archive/plugin.js](https://github.com/twilio/flex-plugin-builder/blob/v4.0.0/dist/commands/flex/plugins/archive/plugin.js)_
 
 ## `twilio flex:plugins:archive:plugin-version`
 
@@ -115,7 +115,7 @@ OPTIONS
   --version=version                (required) The Flex Plugin Version to archive.
 ```
 
-_See code: [dist/commands/flex/plugins/archive/plugin-version.js](https://github.com/twilio/flex-plugin-builder/blob/v4.9.1-beta.0/dist/commands/flex/plugins/archive/plugin-version.js)_
+_See code: [dist/commands/flex/plugins/archive/plugin-version.js](https://github.com/twilio/flex-plugin-builder/blob/v4.0.0/dist/commands/flex/plugins/archive/plugin-version.js)_
 
 ## `twilio flex:plugins:build`
 
@@ -131,11 +131,11 @@ OPTIONS
   --clear-terminal                 Clears the terminal before running the command.
 ```
 
-_See code: [dist/commands/flex/plugins/build.js](https://github.com/twilio/flex-plugin-builder/blob/v4.9.1-beta.0/dist/commands/flex/plugins/build.js)_
+_See code: [dist/commands/flex/plugins/build.js](https://github.com/twilio/flex-plugin-builder/blob/v4.0.0/dist/commands/flex/plugins/build.js)_
 
 ## `twilio flex:plugins:create NAME`
 
-Creates a new Twilio Flex Plugin project
+Creates a new Twilio Flex Plugin project
 
 ```
 USAGE
@@ -158,11 +158,11 @@ OPTIONS
   -y, --yarn                   Use yarn as your dependency manager
 
 DESCRIPTION
-  Arguments:
+  Arguments:
   name	Name of your plugin. This command needs to be invoked inside a plugin directory.
 ```
 
-_See code: [dist/commands/flex/plugins/create.js](https://github.com/twilio/flex-plugin-builder/blob/v4.9.1-beta.0/dist/commands/flex/plugins/create.js)_
+_See code: [dist/commands/flex/plugins/create.js](https://github.com/twilio/flex-plugin-builder/blob/v4.0.0/dist/commands/flex/plugins/create.js)_
 
 ## `twilio flex:plugins:create-configuration`
 
@@ -187,7 +187,7 @@ OPTIONS
                                    as a shortcut for enabling the latest version of the plugin. Use additional
                                    --enable-plugin to provide other plugins to enable.
 
-  --name=name                      (required) [default: Autogenerated Release 1620852163145] The friendly name of the
+  --name=name                      (required) [default: Autogenerated Release 1621275337196] The friendly name of the
                                    Flex Plugin Configuration.
 
   --new                            Creates a new Flex Plugin Configuration, otherwise will append to existing active
@@ -196,7 +196,7 @@ OPTIONS
   --plugin=plugin                  Alias for --enable-plugin.
 ```
 
-_See code: [dist/commands/flex/plugins/create-configuration.js](https://github.com/twilio/flex-plugin-builder/blob/v4.9.1-beta.0/dist/commands/flex/plugins/create-configuration.js)_
+_See code: [dist/commands/flex/plugins/create-configuration.js](https://github.com/twilio/flex-plugin-builder/blob/v4.0.0/dist/commands/flex/plugins/create-configuration.js)_
 
 ## `twilio flex:plugins:deploy`
 
@@ -219,7 +219,7 @@ OPTIONS
   --version=version                Publishes the version (SemVer).
 ```
 
-_See code: [dist/commands/flex/plugins/deploy.js](https://github.com/twilio/flex-plugin-builder/blob/v4.9.1-beta.0/dist/commands/flex/plugins/deploy.js)_
+_See code: [dist/commands/flex/plugins/deploy.js](https://github.com/twilio/flex-plugin-builder/blob/v4.0.0/dist/commands/flex/plugins/deploy.js)_
 
 ## `twilio flex:plugins:describe:configuration`
 
@@ -237,7 +237,7 @@ OPTIONS
   --sid=sid                        (required) The Flex Plugin Configuration SID.
 ```
 
-_See code: [dist/commands/flex/plugins/describe/configuration.js](https://github.com/twilio/flex-plugin-builder/blob/v4.9.1-beta.0/dist/commands/flex/plugins/describe/configuration.js)_
+_See code: [dist/commands/flex/plugins/describe/configuration.js](https://github.com/twilio/flex-plugin-builder/blob/v4.0.0/dist/commands/flex/plugins/describe/configuration.js)_
 
 ## `twilio flex:plugins:describe:plugin`
 
@@ -255,7 +255,7 @@ OPTIONS
   --name=name                      (required) The name of the Flex Plugin to describe.
 ```
 
-_See code: [dist/commands/flex/plugins/describe/plugin.js](https://github.com/twilio/flex-plugin-builder/blob/v4.9.1-beta.0/dist/commands/flex/plugins/describe/plugin.js)_
+_See code: [dist/commands/flex/plugins/describe/plugin.js](https://github.com/twilio/flex-plugin-builder/blob/v4.0.0/dist/commands/flex/plugins/describe/plugin.js)_
 
 ## `twilio flex:plugins:describe:plugin-version`
 
@@ -274,7 +274,7 @@ OPTIONS
   --version=version                (required) The Flex Plugin Version to describe.
 ```
 
-_See code: [dist/commands/flex/plugins/describe/plugin-version.js](https://github.com/twilio/flex-plugin-builder/blob/v4.9.1-beta.0/dist/commands/flex/plugins/describe/plugin-version.js)_
+_See code: [dist/commands/flex/plugins/describe/plugin-version.js](https://github.com/twilio/flex-plugin-builder/blob/v4.0.0/dist/commands/flex/plugins/describe/plugin-version.js)_
 
 ## `twilio flex:plugins:describe:release`
 
@@ -293,7 +293,7 @@ OPTIONS
   --sid=sid                        The Flex Plugin Release SID to describe.
 ```
 
-_See code: [dist/commands/flex/plugins/describe/release.js](https://github.com/twilio/flex-plugin-builder/blob/v4.9.1-beta.0/dist/commands/flex/plugins/describe/release.js)_
+_See code: [dist/commands/flex/plugins/describe/release.js](https://github.com/twilio/flex-plugin-builder/blob/v4.0.0/dist/commands/flex/plugins/describe/release.js)_
 
 ## `twilio flex:plugins:diff ID1 [ID2]`
 
@@ -313,7 +313,7 @@ OPTIONS
   --clear-terminal                 Clears the terminal before running the command.
 ```
 
-_See code: [dist/commands/flex/plugins/diff.js](https://github.com/twilio/flex-plugin-builder/blob/v4.9.1-beta.0/dist/commands/flex/plugins/diff.js)_
+_See code: [dist/commands/flex/plugins/diff.js](https://github.com/twilio/flex-plugin-builder/blob/v4.0.0/dist/commands/flex/plugins/diff.js)_
 
 ## `twilio flex:plugins:list:configurations`
 
@@ -330,7 +330,7 @@ OPTIONS
   --json                           Outputs the result of the command as json string.
 ```
 
-_See code: [dist/commands/flex/plugins/list/configurations.js](https://github.com/twilio/flex-plugin-builder/blob/v4.9.1-beta.0/dist/commands/flex/plugins/list/configurations.js)_
+_See code: [dist/commands/flex/plugins/list/configurations.js](https://github.com/twilio/flex-plugin-builder/blob/v4.0.0/dist/commands/flex/plugins/list/configurations.js)_
 
 ## `twilio flex:plugins:list:plugin-versions`
 
@@ -348,7 +348,7 @@ OPTIONS
   --name=name                      (required) The plugin name to list its versions.
 ```
 
-_See code: [dist/commands/flex/plugins/list/plugin-versions.js](https://github.com/twilio/flex-plugin-builder/blob/v4.9.1-beta.0/dist/commands/flex/plugins/list/plugin-versions.js)_
+_See code: [dist/commands/flex/plugins/list/plugin-versions.js](https://github.com/twilio/flex-plugin-builder/blob/v4.0.0/dist/commands/flex/plugins/list/plugin-versions.js)_
 
 ## `twilio flex:plugins:list:plugins`
 
@@ -365,7 +365,7 @@ OPTIONS
   --json                           Outputs the result of the command as json string.
 ```
 
-_See code: [dist/commands/flex/plugins/list/plugins.js](https://github.com/twilio/flex-plugin-builder/blob/v4.9.1-beta.0/dist/commands/flex/plugins/list/plugins.js)_
+_See code: [dist/commands/flex/plugins/list/plugins.js](https://github.com/twilio/flex-plugin-builder/blob/v4.0.0/dist/commands/flex/plugins/list/plugins.js)_
 
 ## `twilio flex:plugins:list:releases`
 
@@ -382,7 +382,7 @@ OPTIONS
   --json                           Outputs the result of the command as json string.
 ```
 
-_See code: [dist/commands/flex/plugins/list/releases.js](https://github.com/twilio/flex-plugin-builder/blob/v4.9.1-beta.0/dist/commands/flex/plugins/list/releases.js)_
+_See code: [dist/commands/flex/plugins/list/releases.js](https://github.com/twilio/flex-plugin-builder/blob/v4.0.0/dist/commands/flex/plugins/list/releases.js)_
 
 ## `twilio flex:plugins:release`
 
@@ -410,7 +410,7 @@ OPTIONS
                                          pluginName@latest as a shortcut for enabling the latest version of the plugin.
                                          Use additional --enable-plugin to provide other plugins to enable.
 
-  --name=name                            [default: Autogenerated Release 1620852163145] The friendly name of the Flex
+  --name=name                            [default: Autogenerated Release 1621275337196] The friendly name of the Flex
                                          Plugin Configuration.
 
   --new                                  Creates a new Flex Plugin Configuration, otherwise will append to existing
@@ -419,7 +419,7 @@ OPTIONS
   --plugin=plugin                        Alias for --enable-plugin.
 ```
 
-_See code: [dist/commands/flex/plugins/release.js](https://github.com/twilio/flex-plugin-builder/blob/v4.9.1-beta.0/dist/commands/flex/plugins/release.js)_
+_See code: [dist/commands/flex/plugins/release.js](https://github.com/twilio/flex-plugin-builder/blob/v4.0.0/dist/commands/flex/plugins/release.js)_
 
 ## `twilio flex:plugins:start`
 
@@ -440,7 +440,7 @@ OPTIONS
                                    remote plugins using "--name 'plugin-name@remote'".
 ```
 
-_See code: [dist/commands/flex/plugins/start.js](https://github.com/twilio/flex-plugin-builder/blob/v4.9.1-beta.0/dist/commands/flex/plugins/start.js)_
+_See code: [dist/commands/flex/plugins/start.js](https://github.com/twilio/flex-plugin-builder/blob/v4.0.0/dist/commands/flex/plugins/start.js)_
 
 ## `twilio flex:plugins:test`
 
@@ -456,7 +456,7 @@ OPTIONS
   --clear-terminal                 Clears the terminal before running the command.
 ```
 
-_See code: [dist/commands/flex/plugins/test.js](https://github.com/twilio/flex-plugin-builder/blob/v4.9.1-beta.0/dist/commands/flex/plugins/test.js)_
+_See code: [dist/commands/flex/plugins/test.js](https://github.com/twilio/flex-plugin-builder/blob/v4.0.0/dist/commands/flex/plugins/test.js)_
 
 ## `twilio flex:plugins:upgrade-plugin`
 
@@ -483,5 +483,5 @@ OPTIONS
   --yes                            If set, will answer yes to all prompts.
 ```
 
-_See code: [dist/commands/flex/plugins/upgrade-plugin.js](https://github.com/twilio/flex-plugin-builder/blob/v4.9.1-beta.0/dist/commands/flex/plugins/upgrade-plugin.js)_
+_See code: [dist/commands/flex/plugins/upgrade-plugin.js](https://github.com/twilio/flex-plugin-builder/blob/v4.0.0/dist/commands/flex/plugins/upgrade-plugin.js)_
 <!-- commandsstop -->