@contentstack/cli-cm-bulk-publish 1.6.0 → 1.7.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +391 -232
- package/package.json +5 -5
- package/src/commands/cm/assets/publish.js +17 -19
- package/src/commands/cm/assets/unpublish.js +11 -12
- package/src/commands/cm/bulk-publish/cross-publish.js +18 -7
- package/src/commands/cm/entries/publish-modified.js +16 -16
- package/src/commands/cm/entries/publish-non-localized-fields.js +14 -16
- package/src/commands/cm/entries/publish-only-unpublished.js +17 -17
- package/src/commands/cm/entries/publish.js +37 -19
- package/src/commands/cm/entries/unpublish.js +21 -14
- package/src/commands/cm/entries/update-and-publish.js +24 -17
- package/src/commands/cm/stacks/publish-configure.js +2 -2
- package/src/commands/cm/stacks/publish-revert.js +4 -4
- package/src/commands/cm/stacks/unpublish.js +2 -2
- package/src/producer/cross-publish.js +84 -5
- package/src/producer/publish-entries.js +100 -7
- package/src/producer/unpublish.js +77 -10
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@contentstack/cli-cm-bulk-publish",
|
|
3
3
|
"description": "Contentstack CLI plugin for bulk publish actions",
|
|
4
|
-
"version": "1.
|
|
4
|
+
"version": "1.7.0",
|
|
5
5
|
"author": "Contentstack",
|
|
6
6
|
"bugs": "https://github.com/contentstack/cli/issues",
|
|
7
7
|
"dependencies": {
|
|
@@ -14,15 +14,15 @@
|
|
|
14
14
|
"lodash": "^4.17.21",
|
|
15
15
|
"mkdirp": "^1.0.4",
|
|
16
16
|
"nock": "^13.5.5",
|
|
17
|
-
"winston": "^3.
|
|
17
|
+
"winston": "^3.16.0"
|
|
18
18
|
},
|
|
19
19
|
"devDependencies": {
|
|
20
|
-
"@oclif/test": "^
|
|
20
|
+
"@oclif/test": "^4.1.0",
|
|
21
21
|
"chai": "^4.5.0",
|
|
22
22
|
"eslint": "^8.57.1",
|
|
23
23
|
"eslint-config-oclif": "^4.0.0",
|
|
24
24
|
"globby": "^10.0.2",
|
|
25
|
-
"mocha": "^10.
|
|
25
|
+
"mocha": "^10.8.2",
|
|
26
26
|
"nyc": "^15.1.0",
|
|
27
27
|
"oclif": "^3.17.2",
|
|
28
28
|
"tslib": "^1.14.1"
|
|
@@ -99,4 +99,4 @@
|
|
|
99
99
|
"version": "oclif readme && git add README.md",
|
|
100
100
|
"clean": "rm -rf ./node_modules tsconfig.build.tsbuildinfo"
|
|
101
101
|
}
|
|
102
|
-
}
|
|
102
|
+
}
|
|
@@ -157,79 +157,77 @@ But, if retryFailed flag is set, then only a logfile is required
|
|
|
157
157
|
AssetsPublishCommand.flags = {
|
|
158
158
|
alias: flags.string({
|
|
159
159
|
char: 'a',
|
|
160
|
-
description: 'Alias(name) for the management token',
|
|
160
|
+
description: 'Alias (name) for the management token. You must use either the --alias flag or the --stack-api-key flag.',
|
|
161
161
|
}),
|
|
162
162
|
'stack-api-key': flags.string({
|
|
163
163
|
char: 'k',
|
|
164
|
-
description: '
|
|
164
|
+
description: 'API key of the source stack. You must use either the --stack-api-key flag or the --alias flag.',
|
|
165
165
|
required: false,
|
|
166
166
|
}),
|
|
167
167
|
'retry-failed': flags.string({
|
|
168
|
-
description: '
|
|
168
|
+
description: 'Use this option to retry publishing the failed assets from the logfile. Specify the name of the logfile that lists failed publish calls. If this option is used, it will override all other flags.',
|
|
169
169
|
}),
|
|
170
170
|
environments: flags.string({
|
|
171
171
|
char: 'e',
|
|
172
|
-
description: '
|
|
172
|
+
description: 'The name of the environment on which entries will be published. In case of multiple environments, specify their names separated by spaces.',
|
|
173
173
|
multiple: true,
|
|
174
174
|
}),
|
|
175
175
|
'folder-uid': flags.string({
|
|
176
|
-
description: '
|
|
176
|
+
description: '(optional) The UID of the Assets’ folder from which the assets need to be published. The default value is cs_root.',
|
|
177
177
|
exclusive: ['source-env'],
|
|
178
178
|
}),
|
|
179
179
|
'bulk-publish': flags.string({
|
|
180
|
-
description:
|
|
181
|
-
"By default this flag is set as true. It indicates that contentstack's bulkpublish API will be used to publish the assets",
|
|
180
|
+
description: 'Set this flag to use Contentstack’s Bulk Publish APIs. It is true, by default.',
|
|
182
181
|
default: 'true',
|
|
183
182
|
}),
|
|
184
183
|
config: flags.string({
|
|
185
184
|
char: 'c',
|
|
186
|
-
description: '
|
|
185
|
+
description: '(optional) The path of the optional configuration JSON file containing all the options for a single run. Refer to the configure command to create a configuration file.',
|
|
187
186
|
}),
|
|
188
187
|
yes: flags.boolean({
|
|
189
188
|
char: 'y',
|
|
190
|
-
description: '
|
|
189
|
+
description: 'Set it to true to process the command with the current configuration.',
|
|
191
190
|
}),
|
|
192
191
|
locales: flags.string({
|
|
193
192
|
char: 'l',
|
|
194
|
-
description: 'Locales
|
|
193
|
+
description: 'Locales in which assets will be published, e.g., en-us. In the case of multiple locales, specify the codes separated by spaces.',
|
|
195
194
|
multiple: true,
|
|
196
195
|
parse: printFlagDeprecation(['-l'], ['--locales']),
|
|
197
196
|
}),
|
|
198
197
|
branch: flags.string({
|
|
199
198
|
char: 'B',
|
|
200
199
|
default: 'main',
|
|
201
|
-
description: '
|
|
200
|
+
description: 'The name of the branch where you want to perform the bulk publish operation. If you don’t mention the branch name, then by default the assets from the main branch will be published.',
|
|
202
201
|
parse: printFlagDeprecation(['-B'], ['--branch']),
|
|
203
202
|
}),
|
|
204
|
-
|
|
203
|
+
|
|
205
204
|
// To be deprecated
|
|
206
205
|
retryFailed: flags.string({
|
|
207
206
|
char: 'r',
|
|
208
|
-
description: 'Retry publishing failed assets from the logfile (optional, will override all other flags)',
|
|
207
|
+
description: 'Retry publishing failed assets from the logfile (optional, will override all other flags).',
|
|
209
208
|
hidden: true,
|
|
210
209
|
parse: printFlagDeprecation(['-r', '--retryFailed'], ['--retry-failed']),
|
|
211
210
|
}),
|
|
212
211
|
folderUid: flags.string({
|
|
213
212
|
char: 'u',
|
|
214
|
-
description: '
|
|
213
|
+
description: '(default: cs_root) Folder-uid from where the assets will be published.',
|
|
215
214
|
hidden: true,
|
|
216
215
|
parse: printFlagDeprecation(['-u', '--folderUid'], ['--folder-uid']),
|
|
217
216
|
exclusive: ['source-env'],
|
|
218
217
|
}),
|
|
219
218
|
bulkPublish: flags.string({
|
|
220
219
|
char: 'b',
|
|
221
|
-
description:
|
|
222
|
-
"By default this flag is set as true. It indicates that contentstack's bulkpublish API will be used to publish the entries",
|
|
220
|
+
description: "By default this flag is set as true. It indicates that Contentstack's bulk publish API will be used to publish the entries.",
|
|
223
221
|
default: 'true',
|
|
224
222
|
hidden: true,
|
|
225
223
|
parse: printFlagDeprecation(['-b', '--bulkPublish'], ['--bulk-publish']),
|
|
226
224
|
}),
|
|
227
225
|
'api-version': flags.string({
|
|
228
|
-
description
|
|
226
|
+
description: "API version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].",
|
|
229
227
|
}),
|
|
230
|
-
'delivery-token': flags.string({ description: '
|
|
228
|
+
'delivery-token': flags.string({ description: 'The delivery token of the source environment.' }),
|
|
231
229
|
'source-env': flags.string({ description: 'Source environment' }),
|
|
232
|
-
'content-types': flags.string({ description: 'Content types', hidden: true, multiple: true }),
|
|
230
|
+
'content-types': flags.string({ description: 'Content types', hidden: true, multiple: true }),
|
|
233
231
|
};
|
|
234
232
|
|
|
235
233
|
AssetsPublishCommand.examples = [
|
|
@@ -134,45 +134,44 @@ But, if retry-failed flag is set, then only a logfile is required`;
|
|
|
134
134
|
UnpublishCommand.flags = {
|
|
135
135
|
alias: flags.string({
|
|
136
136
|
char: 'a',
|
|
137
|
-
description: 'Alias(name)
|
|
137
|
+
description: 'Alias (name) of the management token. You must use either the --alias flag or the --stack-api-key flag.',
|
|
138
138
|
}),
|
|
139
139
|
'stack-api-key': flags.string({
|
|
140
140
|
char: 'k',
|
|
141
|
-
description: '
|
|
141
|
+
description: 'API key of the source stack. You must use either the --stack-api-key flag or the --alias flag.',
|
|
142
142
|
required: false,
|
|
143
143
|
}),
|
|
144
144
|
environment: flags.string({
|
|
145
145
|
char: 'e',
|
|
146
|
-
description: '
|
|
146
|
+
description: 'The name of the environment from where entries/assets need to be unpublished.',
|
|
147
147
|
}),
|
|
148
148
|
config: flags.string({
|
|
149
149
|
char: 'c',
|
|
150
|
-
description: 'Path to the
|
|
150
|
+
description: '(optional) Path of an optional configuration JSON file containing all the options for a single run. Refer to the configure command to create a configuration file.',
|
|
151
151
|
}),
|
|
152
152
|
yes: flags.boolean({
|
|
153
153
|
char: 'y',
|
|
154
|
-
description: '
|
|
154
|
+
description: 'Set it to true to process the command with the current configuration.',
|
|
155
155
|
}),
|
|
156
156
|
locale: flags.string({
|
|
157
|
-
description: 'Locale
|
|
157
|
+
description: 'Locale from which entries/assets will be unpublished, e.g., en-us.',
|
|
158
158
|
}),
|
|
159
159
|
branch: flags.string({
|
|
160
160
|
default: 'main',
|
|
161
|
-
description: '
|
|
161
|
+
description: 'The name of the branch where you want to perform the bulk unpublish operation. If you don’t mention the branch name, then by default the content from the main branch will be unpublished.',
|
|
162
162
|
}),
|
|
163
163
|
'retry-failed': flags.string({
|
|
164
|
-
description: '
|
|
164
|
+
description: '(optional) Use this option to retry unpublishing the failed entries from the logfile. Specify the name of the logfile that lists failed unpublish calls. If this option is used, it will override all other flags.',
|
|
165
165
|
}),
|
|
166
166
|
'bulk-unpublish': flags.string({
|
|
167
|
-
description:
|
|
168
|
-
"By default this flag is set as true. It indicates that contentstack's bulkpublish API will be used to unpublish the assets",
|
|
167
|
+
description: 'Set this flag to use Contentstack’s Bulk Publish APIs. It is true, by default.',
|
|
169
168
|
default: 'true',
|
|
170
169
|
}),
|
|
171
170
|
'api-version': flags.string({
|
|
172
|
-
description
|
|
171
|
+
description: 'API version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].',
|
|
173
172
|
}),
|
|
174
173
|
'delivery-token': flags.string({
|
|
175
|
-
description: '
|
|
174
|
+
description: 'The delivery token of the source environment.',
|
|
176
175
|
}),
|
|
177
176
|
};
|
|
178
177
|
|
|
@@ -46,7 +46,7 @@ class CrossPublishCommand extends Command {
|
|
|
46
46
|
updatedFlags.deliveryToken = await cliux.prompt('Enter delivery token of your source environment');
|
|
47
47
|
}
|
|
48
48
|
updatedFlags.bulkPublish = updatedFlags.bulkPublish === 'false' ? false : true;
|
|
49
|
-
|
|
49
|
+
updatedFlags.includeVariants = updatedFlags.includeVariants === false ? false : true;
|
|
50
50
|
stack = await getStack(config);
|
|
51
51
|
}
|
|
52
52
|
|
|
@@ -155,6 +155,10 @@ class CrossPublishCommand extends Command {
|
|
|
155
155
|
_flags.deliveryToken = _flags['delivery-token'];
|
|
156
156
|
delete _flags['delivery-token'];
|
|
157
157
|
}
|
|
158
|
+
if ('include-variants' in _flags) {
|
|
159
|
+
_flags.includeVariants = _flags['include-variants'];
|
|
160
|
+
delete _flags['include-variants'];
|
|
161
|
+
}
|
|
158
162
|
return _flags;
|
|
159
163
|
}
|
|
160
164
|
}
|
|
@@ -186,17 +190,17 @@ CrossPublishCommand.flags = {
|
|
|
186
190
|
char: 'b',
|
|
187
191
|
hidden: true,
|
|
188
192
|
description:
|
|
189
|
-
"
|
|
193
|
+
"Set this flag to use Contentstack’s Bulk Publish APIs. It is true, by default.",
|
|
190
194
|
default: 'true',
|
|
191
195
|
parse: printFlagDeprecation(['--bulkPublish', '-b'], ['--bulk-publish']),
|
|
192
196
|
}),
|
|
193
197
|
'bulk-publish': flags.string({
|
|
194
198
|
description:
|
|
195
|
-
"
|
|
199
|
+
"Set this flag to use Contentstack’s Bulk Publish APIs. It is true, by default.",
|
|
196
200
|
default: 'true',
|
|
197
201
|
}),
|
|
198
202
|
'api-version': flags.string({
|
|
199
|
-
description: 'API
|
|
203
|
+
description: 'API version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].',
|
|
200
204
|
}),
|
|
201
205
|
contentType: flags.string({
|
|
202
206
|
char: 't',
|
|
@@ -240,12 +244,12 @@ CrossPublishCommand.flags = {
|
|
|
240
244
|
}),
|
|
241
245
|
deliveryToken: flags.string({
|
|
242
246
|
char: 'x',
|
|
243
|
-
description: '
|
|
247
|
+
description: 'The delivery token of the source environment.',
|
|
244
248
|
hidden: true,
|
|
245
249
|
parse: printFlagDeprecation(['--deliveryToken', '-x'], ['--delivery-token']),
|
|
246
250
|
}),
|
|
247
251
|
'delivery-token': flags.string({
|
|
248
|
-
description: '
|
|
252
|
+
description: 'The delivery token of the source environment.',
|
|
249
253
|
}),
|
|
250
254
|
config: flags.string({ char: 'c', description: 'Path to the config file' }),
|
|
251
255
|
yes: flags.boolean({ char: 'y', description: 'Agree to process the command with the current configuration' }),
|
|
@@ -257,6 +261,10 @@ CrossPublishCommand.flags = {
|
|
|
257
261
|
}),
|
|
258
262
|
onlyAssets: flags.boolean({ description: 'Unpublish only assets', default: false }),
|
|
259
263
|
onlyEntries: flags.boolean({ description: 'Unpublish only entries', default: false }),
|
|
264
|
+
'include-variants': flags.boolean({
|
|
265
|
+
description: 'Include Variants flag will publish all associated variant entries.',
|
|
266
|
+
default: false,
|
|
267
|
+
}),
|
|
260
268
|
};
|
|
261
269
|
|
|
262
270
|
CrossPublishCommand.examples = [
|
|
@@ -278,8 +286,11 @@ CrossPublishCommand.examples = [
|
|
|
278
286
|
'Using --stack-api-key flag',
|
|
279
287
|
'csdx cm:bulk-publish:cross-publish --content-type [CONTENT TYPE] --source-env [SOURCE ENV] --environments [DESTINATION ENVIRONMENT] --locales [LOCALE] --stack-api-key [STACK API KEY] --delivery-token [DELIVERY TOKEN]',
|
|
280
288
|
'',
|
|
289
|
+
'Using --include-variants flag',
|
|
290
|
+
'csdx cm:bulk-publish:cross-publish --content-type [CONTENT TYPE] --source-env [SOURCE ENV] --environments [DESTINATION ENVIRONMENT] --locales [LOCALE] --stack-api-key [STACK API KEY] --delivery-token [DELIVERY TOKEN] [--include-variants]',
|
|
291
|
+
'',
|
|
281
292
|
];
|
|
282
293
|
|
|
283
|
-
CrossPublishCommand.usage = `cm:bulk-publish:cross-publish [-a <value>] [--retry-failed <value>] [--bulk-publish <value>] [--content-type <value>] [--locales <value>] [--source-env <value>] [--environments <value>] [--delivery-token <value>] [-c <value>] [-y] [--branch <value>] [--onlyAssets] [--onlyEntries]`;
|
|
294
|
+
CrossPublishCommand.usage = `cm:bulk-publish:cross-publish [-a <value>] [--retry-failed <value>] [--bulk-publish <value>] [--content-type <value>] [--locales <value>] [--source-env <value>] [--environments <value>] [--delivery-token <value>] [-c <value>] [-y] [--branch <value>] [--onlyAssets] [--onlyEntries] [--include-variants]`;
|
|
284
295
|
|
|
285
296
|
module.exports = CrossPublishCommand;
|
|
@@ -125,69 +125,69 @@ But, if retry-failed flag is set, then only a logfile is required
|
|
|
125
125
|
`;
|
|
126
126
|
|
|
127
127
|
PublishModifiedCommand.flags = {
|
|
128
|
-
alias: flags.string({ char: 'a', description: 'Alias(name)
|
|
128
|
+
alias: flags.string({ char: 'a', description: 'Alias (name) of the management token. You must use either the --alias flag or the --stack-api-key flag.' }),
|
|
129
129
|
'stack-api-key': flags.string({
|
|
130
130
|
char: 'k',
|
|
131
|
-
description: '
|
|
131
|
+
description: 'API key of the source stack. You must use either the --stack-api-key flag or the --alias flag.',
|
|
132
132
|
required: false,
|
|
133
133
|
}),
|
|
134
134
|
retryFailed: flags.string({
|
|
135
135
|
char: 'r',
|
|
136
|
-
description: '
|
|
136
|
+
description: '(optional) Use this option to retry publishing the failed entries/assets from the logfile. Specify the name of the logfile that lists failed publish calls. If this option is used, it will override all other flags',
|
|
137
137
|
hidden: true,
|
|
138
138
|
parse: printFlagDeprecation(['-r', '--retryFailed'], ['--retry-failed']),
|
|
139
139
|
}),
|
|
140
140
|
'retry-failed': flags.string({
|
|
141
|
-
description: '
|
|
141
|
+
description: '(optional) Use this option to retry publishing the failed entries/assets from the logfile. Specify the name of the logfile that lists failed publish calls. If this option is used, it will override all other flags',
|
|
142
142
|
}),
|
|
143
143
|
bulkPublish: flags.string({
|
|
144
144
|
char: 'b',
|
|
145
145
|
description:
|
|
146
|
-
"
|
|
146
|
+
"Set this flag to use Contentstack\'s Bulk Publish APIs. It is true, by default.",
|
|
147
147
|
hidden: true,
|
|
148
148
|
parse: printFlagDeprecation(['-b', '--bulkPublish'], ['--bulk-publish']),
|
|
149
149
|
}),
|
|
150
150
|
'bulk-publish': flags.string({
|
|
151
151
|
description:
|
|
152
|
-
"
|
|
152
|
+
"Set this flag to use Contentstack\'s Bulk Publish APIs. It is true, by default.",
|
|
153
153
|
default: 'true',
|
|
154
154
|
}),
|
|
155
155
|
'api-version': flags.string({
|
|
156
|
-
description : "API
|
|
156
|
+
description : "API version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].",
|
|
157
157
|
}),
|
|
158
158
|
sourceEnv: flags.string({
|
|
159
159
|
char: 's',
|
|
160
|
-
description: '
|
|
160
|
+
description: 'The name of the source environment where the entries were initially published.',
|
|
161
161
|
hidden: true,
|
|
162
162
|
parse: printFlagDeprecation(['-s', '--sourceEnv'], ['--source-env']),
|
|
163
163
|
}),
|
|
164
164
|
'source-env': flags.string({
|
|
165
|
-
description: '
|
|
165
|
+
description: 'The name of the source environment where the entries were initially published.',
|
|
166
166
|
}),
|
|
167
167
|
contentTypes: flags.string({
|
|
168
168
|
char: 't',
|
|
169
|
-
description: 'The
|
|
169
|
+
description: 'The UID of the content type(s) whose edited entries you want to publish in bulk. In case of multiple content types, specify the IDs separated by spaces.',
|
|
170
170
|
multiple: true,
|
|
171
171
|
parse: printFlagDeprecation(['-t', '--contentTypes'], ['--content-types']),
|
|
172
172
|
hidden: true,
|
|
173
173
|
}),
|
|
174
174
|
'content-types': flags.string({
|
|
175
|
-
description: 'The
|
|
175
|
+
description: 'The UID of the content type(s) whose edited entries you want to publish in bulk. In case of multiple content types, specify the IDs separated by spaces.',
|
|
176
176
|
multiple: true,
|
|
177
177
|
}),
|
|
178
178
|
locales: flags.string({
|
|
179
179
|
char: 'l',
|
|
180
|
-
description: 'Locales
|
|
180
|
+
description: 'Locales in which entries will be published, e.g., en-us. In the case of multiple locales, specify the codes separated by spaces.',
|
|
181
181
|
multiple: true,
|
|
182
182
|
parse: printFlagDeprecation(['-l'], ['--locales']),
|
|
183
183
|
}),
|
|
184
|
-
environments: flags.string({ char: 'e', description: '
|
|
185
|
-
config: flags.string({ char: 'c', description: '
|
|
186
|
-
yes: flags.boolean({ char: 'y', description: '
|
|
184
|
+
environments: flags.string({ char: 'e', description: 'The name of the environment(s) on which the entries will be published. In case of multiple environments, specify their names separated by spaces.', multiple: true }),
|
|
185
|
+
config: flags.string({ char: 'c', description: '(optional) The path of the optional configuration JSON file containing all the options for a single run. Refer to the configure command to create a configuration file.' }),
|
|
186
|
+
yes: flags.boolean({ char: 'y', description: 'Set it to true to process the command with the current configuration.' }),
|
|
187
187
|
branch: flags.string({
|
|
188
188
|
char: 'B',
|
|
189
189
|
default: 'main',
|
|
190
|
-
description: '
|
|
190
|
+
description: 'The name of the branch where you want to perform the bulk publish operation. If you don\'t mention the branch name, then by default the entries from main branch will be published.',
|
|
191
191
|
parse: printFlagDeprecation(['-B'], ['--branch']),
|
|
192
192
|
}),
|
|
193
193
|
};
|
|
@@ -129,65 +129,63 @@ But, if retryFailed flag is set, then only a logfile is required`;
|
|
|
129
129
|
NonlocalizedFieldChangesCommand.flags = {
|
|
130
130
|
alias: flags.string({
|
|
131
131
|
char: 'a',
|
|
132
|
-
description: 'Alias(name)
|
|
132
|
+
description: 'Alias (name) of the management token. You must use either the --alias flag or the --stack-api-key flag.',
|
|
133
133
|
}),
|
|
134
134
|
'stack-api-key': flags.string({
|
|
135
135
|
char: 'k',
|
|
136
|
-
description: '
|
|
136
|
+
description: 'API key of the source stack. You must use either the --stack-api-key flag or the --alias flag.',
|
|
137
137
|
required: false,
|
|
138
138
|
}),
|
|
139
139
|
'retry-failed': flags.string({
|
|
140
|
-
description: '
|
|
140
|
+
description: 'Use this option to retry publishing the failed entries from the logfile. Specify the name of the logfile that lists failed publish calls. If this option is used, it will override all other flags.',
|
|
141
141
|
}),
|
|
142
142
|
'bulk-publish': flags.string({
|
|
143
|
-
description:
|
|
144
|
-
"This flag is set to true by default. It indicates that contentstack's bulkpublish API will be used to publish the entries",
|
|
143
|
+
description: "Set this flag to use Contentstack’s Bulk Publish APIs. It is true, by default.",
|
|
145
144
|
default: 'true',
|
|
146
145
|
}),
|
|
147
146
|
'source-env': flags.string({
|
|
148
|
-
description: '
|
|
147
|
+
description: 'The name of the source environment.',
|
|
149
148
|
}),
|
|
150
149
|
'content-types': flags.string({
|
|
151
|
-
description: 'The
|
|
150
|
+
description: 'The UID of the content type whose entries you want to publish in bulk. In case of multiple content types, specify their IDs separated by spaces.',
|
|
152
151
|
multiple: true,
|
|
153
152
|
}),
|
|
154
153
|
environments: flags.string({
|
|
155
154
|
char: 'e',
|
|
156
|
-
description: '
|
|
155
|
+
description: 'The name of the environment on which entries will be published. In case of multiple environments, specify their names separated by spaces.',
|
|
157
156
|
multiple: true,
|
|
158
157
|
}),
|
|
159
158
|
config: flags.string({
|
|
160
159
|
char: 'c',
|
|
161
|
-
description: '
|
|
160
|
+
description: '(optional) The path of the optional configuration JSON file containing all the options for a single run. Refer to the configure command to create a configuration file.',
|
|
162
161
|
}),
|
|
163
162
|
yes: flags.boolean({
|
|
164
163
|
char: 'y',
|
|
165
|
-
description: '
|
|
164
|
+
description: 'Set it to true to process the command with the current configuration.',
|
|
166
165
|
}),
|
|
167
166
|
branch: flags.string({
|
|
168
167
|
char: 'B',
|
|
169
168
|
default: 'main',
|
|
170
|
-
description: '
|
|
169
|
+
description: 'The name of the branch where you want to perform the bulk publish operation. If you don’t mention the branch name, then by default the content from the main branch will be published.',
|
|
171
170
|
parse: printFlagDeprecation(['-B'], ['--branch']),
|
|
172
171
|
}),
|
|
173
172
|
|
|
174
173
|
// To be deprecated
|
|
175
174
|
retryFailed: flags.string({
|
|
176
175
|
char: 'r',
|
|
177
|
-
description: 'Retry publishing failed entries from the logfile',
|
|
176
|
+
description: 'Retry publishing failed entries from the logfile.',
|
|
178
177
|
hidden: true,
|
|
179
178
|
parse: printFlagDeprecation(['-r', '--retryFailed'], ['--retry-failed']),
|
|
180
179
|
}),
|
|
181
180
|
bulkPublish: flags.string({
|
|
182
181
|
char: 'b',
|
|
183
|
-
description:
|
|
184
|
-
"This flag is set to true by default. It indicates that contentstack's bulkpublish API will be used to publish the entries",
|
|
182
|
+
description: "This flag is set to true by default. It indicates that Contentstack's bulk publish API will be used to publish the entries.",
|
|
185
183
|
default: 'true',
|
|
186
184
|
hidden: true,
|
|
187
185
|
parse: printFlagDeprecation(['-b', '--bulkPublish'], ['--bulk-publish']),
|
|
188
186
|
}),
|
|
189
187
|
'api-version': flags.string({
|
|
190
|
-
description
|
|
188
|
+
description: "API version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].",
|
|
191
189
|
}),
|
|
192
190
|
sourceEnv: flags.string({
|
|
193
191
|
char: 's',
|
|
@@ -197,7 +195,7 @@ NonlocalizedFieldChangesCommand.flags = {
|
|
|
197
195
|
}),
|
|
198
196
|
contentTypes: flags.string({
|
|
199
197
|
char: 't',
|
|
200
|
-
description: 'The
|
|
198
|
+
description: 'The content types from which entries will be published.',
|
|
201
199
|
multiple: true,
|
|
202
200
|
hidden: true,
|
|
203
201
|
parse: printFlagDeprecation(['-t', '--contentTypes'], ['--content-types']),
|
|
@@ -21,73 +21,73 @@ But, if retry-failed flag is set, then only a logfile is required
|
|
|
21
21
|
`;
|
|
22
22
|
|
|
23
23
|
PublishOnlyUnpublished.flags = {
|
|
24
|
-
alias: flags.string({ char: 'a', description: 'Alias(name)
|
|
24
|
+
alias: flags.string({ char: 'a', description: 'Alias (name) of the management token. You must use either the --alias flag or the --stack-api-key flag.' }),
|
|
25
25
|
'stack-api-key': flags.string({
|
|
26
26
|
char: 'k',
|
|
27
|
-
description: '
|
|
27
|
+
description: 'API key of the source stack. You must use either the --stack-api-key flag or the --alias flag.',
|
|
28
28
|
}),
|
|
29
29
|
retryFailed: flags.string({
|
|
30
30
|
char: 'r',
|
|
31
31
|
hidden: true,
|
|
32
|
-
description: '
|
|
32
|
+
description: '(optional) Use this option to retry publishing the failed entries from the logfile. It is optional. Specify the name of the logfile that lists failed publish calls. If this option is used, it will override all other flags.',
|
|
33
33
|
parse: printFlagDeprecation(['--retryFailed', '-r'], ['--retry-failed']),
|
|
34
34
|
}),
|
|
35
35
|
'retry-failed': flags.string({
|
|
36
|
-
description: '
|
|
36
|
+
description: '(optional) Use this option to retry publishing the failed entries from the logfile. It is optional. Specify the name of the logfile that lists failed publish calls. If this option is used, it will override all other flags.',
|
|
37
37
|
}),
|
|
38
38
|
bulkPublish: flags.string({
|
|
39
39
|
char: 'b',
|
|
40
40
|
hidden: true,
|
|
41
41
|
description:
|
|
42
|
-
"
|
|
42
|
+
"Set this flag to use Contentstack\'s Bulk Publish APIs. It is true, by default.",
|
|
43
43
|
default: 'true',
|
|
44
44
|
parse: printFlagDeprecation(['--bulkPublish', '-b'], ['--bulk-publish']),
|
|
45
45
|
}),
|
|
46
46
|
'bulk-publish': flags.string({
|
|
47
47
|
char: 'b',
|
|
48
48
|
description:
|
|
49
|
-
"
|
|
49
|
+
"Set this flag to use Contentstack\'s Bulk Publish APIs. It is true, by default.",
|
|
50
50
|
default: 'true',
|
|
51
51
|
}),
|
|
52
52
|
'api-version': flags.string({
|
|
53
|
-
description : "API
|
|
53
|
+
description : "API version to be used. Values [Default: 3, Nested Reference Publishing: 3.2]..",
|
|
54
54
|
}),
|
|
55
55
|
sourceEnv: flags.string({
|
|
56
56
|
char: 's',
|
|
57
57
|
hidden: true,
|
|
58
|
-
description: '
|
|
58
|
+
description: 'The name of the source environment where the entries were initially published.',
|
|
59
59
|
parse: printFlagDeprecation(['--sourceEnv', '-s'], ['--source-env']),
|
|
60
60
|
}),
|
|
61
61
|
'source-env': flags.string({
|
|
62
|
-
description: '
|
|
62
|
+
description: 'The name of the source environment where the entries were initially published.',
|
|
63
63
|
}),
|
|
64
64
|
contentTypes: flags.string({
|
|
65
65
|
char: 't',
|
|
66
|
-
description: 'The
|
|
66
|
+
description: 'The UID of the content type(s) whose entries you want to publish in bulk. In case of multiple content types, specify their IDs separated by spaces.',
|
|
67
67
|
multiple: true,
|
|
68
68
|
hidden: true,
|
|
69
69
|
parse: printFlagDeprecation(['--contentTypes', '-t'], ['--content-types']),
|
|
70
70
|
}),
|
|
71
71
|
'content-types': flags.string({
|
|
72
|
-
description: 'The
|
|
72
|
+
description: 'The UID of the content type(s) whose entries you want to publish in bulk. In case of multiple content types, specify their IDs separated by spaces.',
|
|
73
73
|
multiple: true,
|
|
74
74
|
}),
|
|
75
75
|
locale: flags.string({
|
|
76
76
|
hidden: true,
|
|
77
77
|
char: 'l',
|
|
78
|
-
description: '
|
|
78
|
+
description: 'Locale in which entries will be published, e.g., en-us',
|
|
79
79
|
parse: printFlagDeprecation(['-l'], ['--locales']),
|
|
80
80
|
}),
|
|
81
81
|
locales: flags.string({
|
|
82
|
-
description: '
|
|
82
|
+
description: 'Locale in which entries will be published, e.g., en-us',
|
|
83
83
|
}),
|
|
84
|
-
environments: flags.string({ char: 'e', description: '
|
|
85
|
-
config: flags.string({ char: 'c', description: '
|
|
86
|
-
yes: flags.boolean({ char: 'y', description: '
|
|
84
|
+
environments: flags.string({ char: 'e', description: 'The name of the environment on which entries will be published. In case of multiple environments, specify their names separated by spaces.', multiple: true }),
|
|
85
|
+
config: flags.string({ char: 'c', description: '(optional) The path of the optional configuration JSON file containing all the options for a single run. Refer to the configure command to create a configuration file.' }),
|
|
86
|
+
yes: flags.boolean({ char: 'y', description: 'Set it to true to process the command with the current configuration.' }),
|
|
87
87
|
branch: flags.string({
|
|
88
88
|
char: 'B',
|
|
89
89
|
default: 'main',
|
|
90
|
-
description: '
|
|
90
|
+
description: 'The name of the branch where you want to perform the bulk publish operation. If you don\'t mention the branch name, then by default the entries from main branch will be published.',
|
|
91
91
|
parse: printFlagDeprecation(['-B'], ['--branch']),
|
|
92
92
|
}),
|
|
93
93
|
};
|