Merge branch 'main' of https://github.com/contentstack/cli into main

Author: abhinav-from-contentstack

packages/contentstack-bulk-publish/README.md

@@ -19,7 +19,7 @@ $ npm install -g @contentstack/cli-cm-bulk-publish
 $ csdx COMMAND
 running command...
 $ csdx (-v|--version|version)
-@contentstack/cli-cm-bulk-publish/0.0.20 darwin-x64 node-v10.19.0
+@contentstack/cli-cm-bulk-publish/0.0.20 linux-x64 node-v12.18.4
 $ csdx --help [COMMAND]
 USAGE
   $ csdx COMMAND
@@ -94,8 +94,8 @@ EXAMPLES
   csdx cm:bulk-publish:add-fields -c [PATH TO CONFIG FILE]
 
   Using --retryFailed or -r flag
-  csdx cm:bulk-publish:add-fields --retryFailed [PATH TO LOG FILE]
-  csdx cm:bulk-publish:add-fields -r [PATH TO LOG FILE]
+  csdx cm:bulk-publish:add-fields --retryFailed [LOG FILE NAME]
+  csdx cm:bulk-publish:add-fields -r [LOG FILE NAME]
 ```
 
 _See code: [src/commands/cm/bulk-publish/add-fields.js](https://github.com/contentstack/cli/blob/v0.0.20/src/commands/cm/bulk-publish/add-fields.js)_
@@ -131,7 +131,7 @@ OPTIONS
 DESCRIPTION
   The assets command is used for publishing assets from the specified stack, to the specified environments
 
-  Environment/s are required for executing the command successfully
+  Environment(s) and Locale(s) are required for executing the command successfully
   But, if retryFailed flag is set, then only a logfile is required
 
 EXAMPLES
@@ -141,8 +141,8 @@ EXAMPLES
   csdx cm:bulk-publish:assets -c [PATH TO CONFIG FILE]
 
   Using --retryFailed or -r flag
-  csdx cm:bulk-publish:assets --retryFailed [PATH TO LOG FILE]
-  csdx cm:bulk-publish:assets -r [PATH TO LOG FILE]
+  csdx cm:bulk-publish:assets --retryFailed [LOG FILE NAME]
+  csdx cm:bulk-publish:assets -r [LOG FILE NAME]
 ```
 
 _See code: [src/commands/cm/bulk-publish/assets.js](https://github.com/contentstack/cli/blob/v0.0.20/src/commands/cm/bulk-publish/assets.js)_
@@ -222,7 +222,7 @@ OPTIONS
 DESCRIPTION
   The cross-publish command is used for publishing entries and assets from one evironment to other environments
 
-  Content Types, Environments and Locales are required for executing the command successfully
+  Content Type, Environment, Destination Environment(s) and Locale are required for executing the command successfully
   But, if retryFailed flag is set, then only a logfile is required
 
 EXAMPLES
@@ -232,8 +232,8 @@ EXAMPLES
   csdx cm:bulk-publish:cross-publish -c [PATH TO CONFIG FILE]
 
   Using --retryFailed or -r flag
-  csdx cm:bulk-publish:cross-publish --retryFailed [PATH TO LOG FILE]
-  csdx cm:bulk-publish:cross-publish -r [PATH TO LOG FILE]
+  csdx cm:bulk-publish:cross-publish --retryFailed [LOG FILE NAME]
+  csdx cm:bulk-publish:cross-publish -r [LOG FILE NAME]
 ```
 
 _See code: [src/commands/cm/bulk-publish/cross-publish.js](https://github.com/contentstack/cli/blob/v0.0.20/src/commands/cm/bulk-publish/cross-publish.js)_
@@ -284,8 +284,8 @@ EXAMPLES
   csdx cm:bulk-publish:entries -c [PATH TO CONFIG FILE]
 
   Using --retryFailed or -r flag
-  csdx cm:bulk-publish:entries --retryFailed [PATH TO LOG FILE]
-  csdx cm:bulk-publish:entries -r [PATH TO LOG FILE]
+  csdx cm:bulk-publish:entries --retryFailed [LOG FILE NAME]
+  csdx cm:bulk-publish:entries -r [LOG FILE NAME]
 ```
 
 _See code: [src/commands/cm/bulk-publish/entries.js](https://github.com/contentstack/cli/blob/v0.0.20/src/commands/cm/bulk-publish/entries.js)_
@@ -324,7 +324,8 @@ DESCRIPTION
   The entry-edits command is used for publishing entries from the specified content types, to the
   specified environments and locales
 
-  Content Types, Environments and Locales are required for executing the command successfully
+  Content Type(s), Source Environment, Destination Environment(s) and Locale(s) are required for executing the command 
+  successfully
   But, if retryFailed flag is set, then only a logfile is required
 
 EXAMPLES
@@ -334,8 +335,8 @@ EXAMPLES
   csdx cm:bulk-publish:entry-edits -c [PATH TO CONFIG FILE]
 
   Using --retryFailed or -r flag
-  csdx cm:bulk-publish:entry-edits --retryFailed [PATH TO LOG FILE]
-  csdx cm:bulk-publish:entry-edits -r [PATH TO LOG FILE]
+  csdx cm:bulk-publish:entry-edits --retryFailed [LOG FILE NAME]
+  csdx cm:bulk-publish:entry-edits -r [LOG FILE NAME]
 ```
 
 _See code: [src/commands/cm/bulk-publish/entry-edits.js](https://github.com/contentstack/cli/blob/v0.0.20/src/commands/cm/bulk-publish/entry-edits.js)_
@@ -382,8 +383,8 @@ EXAMPLES
   csdx cm:bulk-publish:nonlocalized-field-changes -c [PATH TO CONFIG FILE]
 
   Using --retryFailed or -r flag
-  csdx cm:bulk-publish:nonlocalized-field-changes --retryFailed [PATH TO LOG FILE]
-  csdx cm:bulk-publish:nonlocalized-field-changes -r [PATH TO LOG FILE]
+  csdx cm:bulk-publish:nonlocalized-field-changes --retryFailed [LOG FILE NAME]
+  csdx cm:bulk-publish:nonlocalized-field-changes -r [LOG FILE NAME]
 ```
 
 _See code: [src/commands/cm/bulk-publish/nonlocalized-field-changes.js](https://github.com/contentstack/cli/blob/v0.0.20/src/commands/cm/bulk-publish/nonlocalized-field-changes.js)_
@@ -401,24 +402,17 @@ OPTIONS
   -r, --retryFailed=retryFailed  retry publishing failed entries from the logfile
 
 DESCRIPTION
-  ...
   The revert command is used for reverting all publish operations performed using bulk-publish script.
+  A log file name is required to execute revert command
 
-  Here is a detailed description for all the available flags
-  -----------------------------------------------------------------------------------------------------------
-  --retryFailed or -r : This flag is used to retry publishing entries or assets, that failed to publish in a previous
-  attempt. A log file for the previous session will be required for processing the failed elements. 
-
-  NOTE: When retryFailed flag is set, all other flags will be ignored
-
-  EXAMPLE : cm:bulk-publish:revert --retryFailed [PATH TO LOG FILE]
-  EXAMPLE : cm:bulk-publish:revert -r [PATH TO LOG FILE]
-  -----------------------------------------------------------------------------------------------------------
-  --logFile or -l : logFile to be used for revert
+EXAMPLES
+  Using --logFile
+  cm:bulk-publish:revert --logFile [LOG FILE NAME]
+  cm:bulk-publish:revert -l [LOG FILE NAME]
 
-  EXAMPLE : cm:bulk-publish:revert --logFile [PATH TO LOG FILE]
-  EXAMPLE : cm:bulk-publish:revert -l [PATH TO LOG FILE]
-  -----------------------------------------------------------------------------------------------------------
+  Using --retryFailed
+  cm:bulk-publish:revert --retryFailed [LOG FILE NAME]
+  cm:bulk-publish:revert -r [LOG FILE NAME]
 ```
 
 _See code: [src/commands/cm/bulk-publish/revert.js](https://github.com/contentstack/cli/blob/v0.0.20/src/commands/cm/bulk-publish/revert.js)_
@@ -459,18 +453,36 @@ OPTIONS
 DESCRIPTION
   The unpublish command is used for unpublishing entries from given environment
 
-  Content Types, Environments and Locales are required for executing the command successfully
+  Environment (Source Environment) and Locale are required for executing the command successfully
   But, if retryFailed flag is set, then only a logfile is required
 
+  A Content Type can be specified for publishing entries, but if no content-type(s) is/are specified and --onlyAssets is 
+  not used,
+  then all entries from all content types will be unpublished from the source environment
+
 EXAMPLES
   Using --config or -c flag
   Generate a config file at the current working directory using `csdx cm:bulk-publish:configure -a [ALIAS]`
   csdx cm:bulk-publish:unpublish --config [PATH TO CONFIG FILE]
   csdx cm:bulk-publish:unpublish -c [PATH TO CONFIG FILE]
 
   Using --retryFailed or -r flag
-  csdx cm:bulk-publish:unpublish --retryFailed [PATH TO LOG FILE]
-  csdx cm:bulk-publish:unpublish -r [PATH TO LOG FILE]
+  csdx cm:bulk-publish:unpublish --retryFailed [LOG FILE NAME]
+  csdx cm:bulk-publish:unpublish -r [LOG FILE NAME]
+
+  No content type
+  csdx cm:bulk-publish:unpublish --environment [SOURCE ENV] --locale [LOCALE] (Will unpublish all entries from all 
+  content types and assets from the source environment)
+
+  Using --onlyAssets
+  csdx cm:bulk-publish:unpublish --environment [SOURCE ENV] --locale [LOCALE] --onlyAssets (Will unpublish only assets 
+  from the source environment)
+
+  Using --onlyEntries
+  csdx cm:bulk-publish:unpublish --environment [SOURCE ENV] --locale [LOCALE] --onlyEntries (Will unpublish only 
+  entries, all entries, from the source environment)
+  csdx cm:bulk-publish:unpublish --contentType [CONTENT TYPE] --environment [SOURCE ENV] --locale [LOCALE] --onlyEntries 
+  (Will unpublish only entries, (from CONTENT TYPE) from the source environment)
 ```
 
 _See code: [src/commands/cm/bulk-publish/unpublish.js](https://github.com/contentstack/cli/blob/v0.0.20/src/commands/cm/bulk-publish/unpublish.js)_
@@ -508,7 +520,8 @@ DESCRIPTION
   The unpublished-entries command is used for publishing unpublished entries from the source environment, to other 
   environments and locales
 
-  Content Types, Environments and Locales are required for executing the command successfully
+  Content Type(s), Source Environment, Destination Environment(s) and Source Locale are required for executing the 
+  command successfully
   But, if retryFailed flag is set, then only a logfile is required
 
 EXAMPLES
@@ -518,8 +531,8 @@ EXAMPLES
   csdx cm:bulk-publish:unpublished-entries -c [PATH TO CONFIG FILE]
 
   Using --retryFailed or -r flag
-  csdx cm:bulk-publish:unpublished-entries --retryFailed [PATH TO LOG FILE]
-  csdx cm:bulk-publish:unpublished-entries -r [PATH TO LOG FILE]
+  csdx cm:bulk-publish:unpublished-entries --retryFailed [LOG FILE NAME]
+  csdx cm:bulk-publish:unpublished-entries -r [LOG FILE NAME]
 ```
 
 _See code: [src/commands/cm/bulk-publish/unpublished-entries.js](https://github.com/contentstack/cli/blob/v0.0.20/src/commands/cm/bulk-publish/unpublished-entries.js)_

packages/contentstack-bulk-publish/src/commands/cm/bulk-publish/add-fields.js

@@ -109,8 +109,8 @@ AddFieldsCommand.examples = [
   'csdx cm:bulk-publish:add-fields -c [PATH TO CONFIG FILE]',
   '',
   'Using --retryFailed or -r flag',
-  'csdx cm:bulk-publish:add-fields --retryFailed [PATH TO LOG FILE]',
-  'csdx cm:bulk-publish:add-fields -r [PATH TO LOG FILE]'
+  'csdx cm:bulk-publish:add-fields --retryFailed [LOG FILE NAME]',
+  'csdx cm:bulk-publish:add-fields -r [LOG FILE NAME]'
 ]
 
 module.exports = AddFieldsCommand

packages/contentstack-bulk-publish/src/commands/cm/bulk-publish/assets.js

@@ -85,7 +85,7 @@ class AssetsCommand extends Command {
 AssetsCommand.description = `Publish assets to specified environments
 The assets command is used for publishing assets from the specified stack, to the specified environments
 
-Environment/s are required for executing the command successfully
+Environment(s) and Locale(s) are required for executing the command successfully
 But, if retryFailed flag is set, then only a logfile is required
 `
 
@@ -109,8 +109,8 @@ AssetsCommand.examples = [
   'csdx cm:bulk-publish:assets -c [PATH TO CONFIG FILE]',
   '',
   'Using --retryFailed or -r flag',
-  'csdx cm:bulk-publish:assets --retryFailed [PATH TO LOG FILE]',
-  'csdx cm:bulk-publish:assets -r [PATH TO LOG FILE]'
+  'csdx cm:bulk-publish:assets --retryFailed [LOG FILE NAME]',
+  'csdx cm:bulk-publish:assets -r [LOG FILE NAME]'
 ]
 
 module.exports = AssetsCommand

packages/contentstack-bulk-publish/src/commands/cm/bulk-publish/cross-publish.js

@@ -113,7 +113,7 @@ class CrossPublishCommand extends Command {
 CrossPublishCommand.description = `Publish entries and assets from one environment to other environments
 The cross-publish command is used for publishing entries and assets from one evironment to other environments
 
-Content Types, Environments and Locales are required for executing the command successfully
+Content Type, Environment, Destination Environment(s) and Locale are required for executing the command successfully
 But, if retryFailed flag is set, then only a logfile is required
 `
 
@@ -139,8 +139,8 @@ CrossPublishCommand.examples = [
   'csdx cm:bulk-publish:cross-publish -c [PATH TO CONFIG FILE]',
   '',
   'Using --retryFailed or -r flag',
-  'csdx cm:bulk-publish:cross-publish --retryFailed [PATH TO LOG FILE]',
-  'csdx cm:bulk-publish:cross-publish -r [PATH TO LOG FILE]'
+  'csdx cm:bulk-publish:cross-publish --retryFailed [LOG FILE NAME]',
+  'csdx cm:bulk-publish:cross-publish -r [LOG FILE NAME]'
 ]
 
 module.exports = CrossPublishCommand

packages/contentstack-bulk-publish/src/commands/cm/bulk-publish/entries.js

@@ -117,8 +117,8 @@ EntriesCommand.examples = [
   'csdx cm:bulk-publish:entries -c [PATH TO CONFIG FILE]',
   '',
   'Using --retryFailed or -r flag',
-  'csdx cm:bulk-publish:entries --retryFailed [PATH TO LOG FILE]',
-  'csdx cm:bulk-publish:entries -r [PATH TO LOG FILE]'
+  'csdx cm:bulk-publish:entries --retryFailed [LOG FILE NAME]',
+  'csdx cm:bulk-publish:entries -r [LOG FILE NAME]'
 ]
 
 module.exports = EntriesCommand

packages/contentstack-bulk-publish/src/commands/cm/bulk-publish/entry-edits.js

@@ -90,7 +90,7 @@ EntryEditsCommand.description = `Publish edited entries from a specified Content
 The entry-edits command is used for publishing entries from the specified content types, to the
 specified environments and locales
 
-Content Types, Environments and Locales are required for executing the command successfully
+Content Type(s), Source Environment, Destination Environment(s) and Locale(s) are required for executing the command successfully
 But, if retryFailed flag is set, then only a logfile is required
 `
 
@@ -115,8 +115,8 @@ EntryEditsCommand.examples = [
   'csdx cm:bulk-publish:entry-edits -c [PATH TO CONFIG FILE]',
   '',
   'Using --retryFailed or -r flag',
-  'csdx cm:bulk-publish:entry-edits --retryFailed [PATH TO LOG FILE]',
-  'csdx cm:bulk-publish:entry-edits -r [PATH TO LOG FILE]'
+  'csdx cm:bulk-publish:entry-edits --retryFailed [LOG FILE NAME]',
+  'csdx cm:bulk-publish:entry-edits -r [LOG FILE NAME]'
 ]
 
 module.exports = EntryEditsCommand

packages/contentstack-bulk-publish/src/commands/cm/bulk-publish/nonlocalized-field-changes.js

@@ -108,8 +108,8 @@ NonlocalizedFieldChangesCommand.examples = [
   'csdx cm:bulk-publish:nonlocalized-field-changes -c [PATH TO CONFIG FILE]',
   '',
   'Using --retryFailed or -r flag',
-  'csdx cm:bulk-publish:nonlocalized-field-changes --retryFailed [PATH TO LOG FILE]',
-  'csdx cm:bulk-publish:nonlocalized-field-changes -r [PATH TO LOG FILE]'
+  'csdx cm:bulk-publish:nonlocalized-field-changes --retryFailed [LOG FILE NAME]',
+  'csdx cm:bulk-publish:nonlocalized-field-changes -r [LOG FILE NAME]'
 ]
 
 module.exports = NonlocalizedFieldChangesCommand

packages/contentstack-bulk-publish/src/commands/cm/bulk-publish/revert.js

@@ -59,29 +59,23 @@ class RevertCommand extends Command {
 }
 
 RevertCommand.description = `Revert publish operations by using a log file
-...
 The revert command is used for reverting all publish operations performed using bulk-publish script.
-
-Here is a detailed description for all the available flags
------------------------------------------------------------------------------------------------------------
---retryFailed or -r : This flag is used to retry publishing entries or assets, that failed to publish in a previous
-attempt. A log file for the previous session will be required for processing the failed elements. 
-
-NOTE: When retryFailed flag is set, all other flags will be ignored
-
-EXAMPLE : cm:bulk-publish:revert --retryFailed [PATH TO LOG FILE]
-EXAMPLE : cm:bulk-publish:revert -r [PATH TO LOG FILE]
------------------------------------------------------------------------------------------------------------
---logFile or -l : logFile to be used for revert
-
-EXAMPLE : cm:bulk-publish:revert --logFile [PATH TO LOG FILE]
-EXAMPLE : cm:bulk-publish:revert -l [PATH TO LOG FILE]
------------------------------------------------------------------------------------------------------------
+A log file name is required to execute revert command
 `
 
 RevertCommand.flags = {
   retryFailed: flags.string({char: 'r', description: 'retry publishing failed entries from the logfile'}),
   logFile: flags.string({char: 'l', description: 'logfile to be used to revert'}),
 }
 
+RevertCommand.examples = [
+  'Using --logFile',
+  'cm:bulk-publish:revert --logFile [LOG FILE NAME]',
+  'cm:bulk-publish:revert -l [LOG FILE NAME]',
+  '',
+  'Using --retryFailed',
+  'cm:bulk-publish:revert --retryFailed [LOG FILE NAME]',
+  'cm:bulk-publish:revert -r [LOG FILE NAME]',
+]
+
 module.exports = RevertCommand

packages/contentstack-bulk-publish/src/commands/cm/bulk-publish/unpublish.js

@@ -109,8 +109,14 @@ class UnpublishCommand extends Command {
 UnpublishCommand.description = `Unpublish entries of given Content Types from given environment
 The unpublish command is used for unpublishing entries from given environment
 
-Content Types, Environments and Locales are required for executing the command successfully
+Environment (Source Environment) and Locale are required for executing the command successfully
 But, if retryFailed flag is set, then only a logfile is required
+
+A Content Type can be specified for publishing entries, but if no content-type(s) is/are specified and --onlyAssets is not used,
+then all entries from all content types will be unpublished from the source environment
+
+--onlyAssets can be used to unpublish only assets and --onlyEntries can be used to unpublish only entries.
+(--onlyAssets and --onlyEntries cannot be used together at the same time)
 `
 
 UnpublishCommand.flags = {
@@ -136,8 +142,18 @@ UnpublishCommand.examples = [
   'csdx cm:bulk-publish:unpublish -c [PATH TO CONFIG FILE]',
   '',
   'Using --retryFailed or -r flag',
-  'csdx cm:bulk-publish:unpublish --retryFailed [PATH TO LOG FILE]',
-  'csdx cm:bulk-publish:unpublish -r [PATH TO LOG FILE]'
+  'csdx cm:bulk-publish:unpublish --retryFailed [LOG FILE NAME]',
+  'csdx cm:bulk-publish:unpublish -r [LOG FILE NAME]',
+  '',
+  'No content type',
+  'csdx cm:bulk-publish:unpublish --environment [SOURCE ENV] --locale [LOCALE] (Will unpublish all entries from all content types and assets from the source environment)',
+  '',
+  'Using --onlyAssets',
+  'csdx cm:bulk-publish:unpublish --environment [SOURCE ENV] --locale [LOCALE] --onlyAssets (Will unpublish only assets from the source environment)',
+  '',
+  'Using --onlyEntries',
+  'csdx cm:bulk-publish:unpublish --environment [SOURCE ENV] --locale [LOCALE] --onlyEntries (Will unpublish only entries, all entries, from the source environment)',
+  'csdx cm:bulk-publish:unpublish --contentType [CONTENT TYPE] --environment [SOURCE ENV] --locale [LOCALE] --onlyEntries (Will unpublish only entries, (from CONTENT TYPE) from the source environment)',
 ]
 
 module.exports = UnpublishCommand

packages/contentstack-bulk-publish/src/commands/cm/bulk-publish/unpublished-entries.js

@@ -89,7 +89,7 @@ class UnpublishedEntriesCommand extends Command {
 UnpublishedEntriesCommand.description = `Publish unpublished entries from the source environment, to other environments and locales
 The unpublished-entries command is used for publishing unpublished entries from the source environment, to other environments and locales
 
-Content Types, Environments and Locales are required for executing the command successfully
+Content Type(s), Source Environment, Destination Environment(s) and Source Locale are required for executing the command successfully
 But, if retryFailed flag is set, then only a logfile is required
 `
 
@@ -114,8 +114,8 @@ UnpublishedEntriesCommand.examples = [
   'csdx cm:bulk-publish:unpublished-entries -c [PATH TO CONFIG FILE]',
   '',
   'Using --retryFailed or -r flag',
-  'csdx cm:bulk-publish:unpublished-entries --retryFailed [PATH TO LOG FILE]',
-  'csdx cm:bulk-publish:unpublished-entries -r [PATH TO LOG FILE]'
+  'csdx cm:bulk-publish:unpublished-entries --retryFailed [LOG FILE NAME]',
+  'csdx cm:bulk-publish:unpublished-entries -r [LOG FILE NAME]'
 ]
 
 module.exports = UnpublishedEntriesCommand