@salesforce/cli 2.156.3 → 2.156.5

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.
Files changed (3) hide show
  1. package/README.md +118 -118
  2. package/oclif.manifest.json +1112 -1112
  3. package/package.json +25 -25
@@ -2446,194 +2446,6 @@
2446
2446
  "promote.js"
2447
2447
  ]
2448
2448
  },
2449
- "devops:promotion:complete": {
2450
- "aliases": [],
2451
- "args": {},
2452
- "description": "Deploys work items that were merged into the pipeline branch outside of DevOps Center (externally merged) into the target stage org and updates DevOps Center records. Equivalent to the \"Complete Promotion\" action in the DevOps Center UI when a stage is out of sync.\n\nIf no undeployed work items are found for the stage, the command exits successfully with no action taken.",
2453
- "examples": [
2454
- "Complete a promotion for an out-of-sync pipeline stage:\n<%= config.bin %> <%= command.id %> --target-org my-devops-org --target-stage-id 1QV000000000001",
2455
- "Complete a promotion for a specific work item (e.g. first stage of a pipeline):\n<%= config.bin %> <%= command.id %> --target-org my-devops-org --target-stage-id 1QV000000000001 --work-item-id 1fk000000000001",
2456
- "Complete a promotion with full deploy and a specific test level:\n<%= config.bin %> <%= command.id %> --target-org my-devops-org --target-stage-id 1QV000000000001 --deploy-all --test-level RunLocalTests"
2457
- ],
2458
- "flags": {
2459
- "json": {
2460
- "description": "Format output as json.",
2461
- "helpGroup": "GLOBAL",
2462
- "name": "json",
2463
- "allowNo": false,
2464
- "type": "boolean"
2465
- },
2466
- "flags-dir": {
2467
- "helpGroup": "GLOBAL",
2468
- "name": "flags-dir",
2469
- "summary": "Import flag values from a directory.",
2470
- "hasDynamicHelp": false,
2471
- "multiple": false,
2472
- "type": "option"
2473
- },
2474
- "target-org": {
2475
- "char": "o",
2476
- "name": "target-org",
2477
- "noCacheDefault": true,
2478
- "required": true,
2479
- "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
2480
- "hasDynamicHelp": true,
2481
- "multiple": false,
2482
- "type": "option"
2483
- },
2484
- "api-version": {
2485
- "description": "Override the api version used for api requests made by this command",
2486
- "name": "api-version",
2487
- "hasDynamicHelp": false,
2488
- "multiple": false,
2489
- "type": "option"
2490
- },
2491
- "target-stage-id": {
2492
- "char": "t",
2493
- "name": "target-stage-id",
2494
- "required": true,
2495
- "summary": "ID of the out-of-sync pipeline stage to deploy to.",
2496
- "hasDynamicHelp": false,
2497
- "multiple": false,
2498
- "type": "option"
2499
- },
2500
- "work-item-id": {
2501
- "char": "i",
2502
- "name": "work-item-id",
2503
- "required": false,
2504
- "summary": "ID of a specific work item to deploy. Omit to deploy all undeployed work items for the stage. Use this for the first stage of a pipeline where no source stage exists.",
2505
- "hasDynamicHelp": false,
2506
- "multiple": true,
2507
- "type": "option"
2508
- },
2509
- "deploy-all": {
2510
- "char": "a",
2511
- "description": "If you don’t specify this flag, only changes in the stage’s branch are deployed.",
2512
- "name": "deploy-all",
2513
- "summary": "Deploy all metadata in the branch to the stage's org.",
2514
- "allowNo": false,
2515
- "type": "boolean"
2516
- },
2517
- "test-level": {
2518
- "char": "l",
2519
- "description": "Valid values are:\n\n- NoTestRun — No tests are run. This test level applies only to deployments to development environments, such as sandbox, Developer Edition, or trial orgs. This test level is the default for development environments.\n\n- RunSpecifiedTests — Runs only the tests that you specify with the --tests flag. Code coverage requirements differ from the default coverage requirements when using this test level. Executed tests must comprise a minimum of 75% code coverage for each class and trigger in the deployment package. This coverage is computed for each class and trigger individually and is different than the overall coverage percentage.\n\n- RunLocalTests — All tests in your org are run, except the ones that originate from installed managed and unlocked packages. This test level is the default for production deployments that include Apex classes or triggers.\n\n- RunAllTestsInOrg — All tests in your org are run, including tests of managed packages.\n\nIf you don’t specify a test level, the default behavior depends on the contents of your deployment package. For more information, see the section \"Running Tests in a Deployment\" in the \"Metadata API Developer Guide\". (https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_deploy_running_tests.htm)",
2520
- "name": "test-level",
2521
- "summary": "Deployment Apex testing level.",
2522
- "hasDynamicHelp": false,
2523
- "multiple": false,
2524
- "options": [
2525
- "NoTestRun",
2526
- "RunSpecifiedTests",
2527
- "RunLocalTests",
2528
- "RunAllTestsInOrg"
2529
- ],
2530
- "type": "option"
2531
- },
2532
- "tests": {
2533
- "description": "Separate multiple test names with commas. Enclose the entire flag value in double quotes if a test name contains spaces.",
2534
- "name": "tests",
2535
- "summary": "Apex tests to run when --test-level is RunSpecifiedTests.",
2536
- "hasDynamicHelp": false,
2537
- "multiple": true,
2538
- "type": "option"
2539
- }
2540
- },
2541
- "hasDynamicHelp": true,
2542
- "hiddenAliases": [],
2543
- "id": "devops:promotion:complete",
2544
- "pluginAlias": "@salesforce/plugin-devops-center",
2545
- "pluginName": "@salesforce/plugin-devops-center",
2546
- "pluginType": "jit",
2547
- "strict": true,
2548
- "summary": "Deploy undeployed work items to a pipeline stage org.",
2549
- "enableJsonFlag": true,
2550
- "isESM": true,
2551
- "relativePath": [
2552
- "lib",
2553
- "commands",
2554
- "devops",
2555
- "promotion",
2556
- "complete.js"
2557
- ]
2558
- },
2559
- "devops:promotion:validate": {
2560
- "aliases": [],
2561
- "args": {},
2562
- "description": "Validates whether the specified work items can be promoted to the target pipeline stage. Checks for VCS and object permission errors before a promotion is attempted.",
2563
- "examples": [
2564
- "Validate promotion of a work item to a target stage:\n<%= config.bin %> <%= command.id %> --target-org my-devops-org --target-stage-id 1QV000000000001 --work-item-id 1fk000000000001",
2565
- "Validate promotion of multiple work items:\n<%= config.bin %> <%= command.id %> --target-org my-devops-org --target-stage-id 1QV000000000001 --work-item-id 1fk000000000001 --work-item-id 1fk000000000002"
2566
- ],
2567
- "flags": {
2568
- "json": {
2569
- "description": "Format output as json.",
2570
- "helpGroup": "GLOBAL",
2571
- "name": "json",
2572
- "allowNo": false,
2573
- "type": "boolean"
2574
- },
2575
- "flags-dir": {
2576
- "helpGroup": "GLOBAL",
2577
- "name": "flags-dir",
2578
- "summary": "Import flag values from a directory.",
2579
- "hasDynamicHelp": false,
2580
- "multiple": false,
2581
- "type": "option"
2582
- },
2583
- "target-org": {
2584
- "char": "o",
2585
- "name": "target-org",
2586
- "noCacheDefault": true,
2587
- "required": true,
2588
- "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
2589
- "hasDynamicHelp": true,
2590
- "multiple": false,
2591
- "type": "option"
2592
- },
2593
- "api-version": {
2594
- "description": "Override the api version used for api requests made by this command",
2595
- "name": "api-version",
2596
- "hasDynamicHelp": false,
2597
- "multiple": false,
2598
- "type": "option"
2599
- },
2600
- "target-stage-id": {
2601
- "char": "t",
2602
- "name": "target-stage-id",
2603
- "required": true,
2604
- "summary": "ID of the target pipeline stage to validate promotion to.",
2605
- "hasDynamicHelp": false,
2606
- "multiple": false,
2607
- "type": "option"
2608
- },
2609
- "work-item-id": {
2610
- "char": "i",
2611
- "name": "work-item-id",
2612
- "required": true,
2613
- "summary": "ID of a work item to validate for promotion. Specify multiple times for multiple work items.",
2614
- "hasDynamicHelp": false,
2615
- "multiple": true,
2616
- "type": "option"
2617
- }
2618
- },
2619
- "hasDynamicHelp": true,
2620
- "hiddenAliases": [],
2621
- "id": "devops:promotion:validate",
2622
- "pluginAlias": "@salesforce/plugin-devops-center",
2623
- "pluginName": "@salesforce/plugin-devops-center",
2624
- "pluginType": "jit",
2625
- "strict": true,
2626
- "summary": "Validate work item promotion for a pipeline stage.",
2627
- "enableJsonFlag": true,
2628
- "isESM": true,
2629
- "relativePath": [
2630
- "lib",
2631
- "commands",
2632
- "devops",
2633
- "promotion",
2634
- "validate.js"
2635
- ]
2636
- },
2637
2449
  "devops:project:create": {
2638
2450
  "aliases": [],
2639
2451
  "args": {},
@@ -3223,12 +3035,14 @@
3223
3035
  "update.js"
3224
3036
  ]
3225
3037
  },
3226
- "devops:request:status": {
3038
+ "devops:promotion:complete": {
3227
3039
  "aliases": [],
3228
3040
  "args": {},
3229
- "description": "Returns the current status of a request identified by its request token.",
3041
+ "description": "Deploys work items that were merged into the pipeline branch outside of DevOps Center (externally merged) into the target stage org and updates DevOps Center records. Equivalent to the \"Complete Promotion\" action in the DevOps Center UI when a stage is out of sync.\n\nIf no undeployed work items are found for the stage, the command exits successfully with no action taken.",
3230
3042
  "examples": [
3231
- "Get the status of a request:\n<%= config.bin %> <%= command.id %> --target-org my-devops-org --request-token a0B000000000001"
3043
+ "Complete a promotion for an out-of-sync pipeline stage:\n<%= config.bin %> <%= command.id %> --target-org my-devops-org --target-stage-id 1QV000000000001",
3044
+ "Complete a promotion for a specific work item (e.g. first stage of a pipeline):\n<%= config.bin %> <%= command.id %> --target-org my-devops-org --target-stage-id 1QV000000000001 --work-item-id 1fk000000000001",
3045
+ "Complete a promotion with full deploy and a specific test level:\n<%= config.bin %> <%= command.id %> --target-org my-devops-org --target-stage-id 1QV000000000001 --deploy-all --test-level RunLocalTests"
3232
3046
  ],
3233
3047
  "flags": {
3234
3048
  "json": {
@@ -3263,38 +3077,156 @@
3263
3077
  "multiple": false,
3264
3078
  "type": "option"
3265
3079
  },
3266
- "request-token": {
3267
- "char": "i",
3268
- "name": "request-token",
3080
+ "target-stage-id": {
3081
+ "char": "t",
3082
+ "name": "target-stage-id",
3269
3083
  "required": true,
3270
- "summary": "Request token from the promote response.",
3084
+ "summary": "ID of the out-of-sync pipeline stage to deploy to.",
3085
+ "hasDynamicHelp": false,
3086
+ "multiple": false,
3087
+ "type": "option"
3088
+ },
3089
+ "work-item-id": {
3090
+ "char": "i",
3091
+ "name": "work-item-id",
3092
+ "required": false,
3093
+ "summary": "ID of a specific work item to deploy. Omit to deploy all undeployed work items for the stage. Use this for the first stage of a pipeline where no source stage exists.",
3094
+ "hasDynamicHelp": false,
3095
+ "multiple": true,
3096
+ "type": "option"
3097
+ },
3098
+ "deploy-all": {
3099
+ "char": "a",
3100
+ "description": "If you don’t specify this flag, only changes in the stage’s branch are deployed.",
3101
+ "name": "deploy-all",
3102
+ "summary": "Deploy all metadata in the branch to the stage's org.",
3103
+ "allowNo": false,
3104
+ "type": "boolean"
3105
+ },
3106
+ "test-level": {
3107
+ "char": "l",
3108
+ "description": "Valid values are:\n\n- NoTestRun — No tests are run. This test level applies only to deployments to development environments, such as sandbox, Developer Edition, or trial orgs. This test level is the default for development environments.\n\n- RunSpecifiedTests — Runs only the tests that you specify with the --tests flag. Code coverage requirements differ from the default coverage requirements when using this test level. Executed tests must comprise a minimum of 75% code coverage for each class and trigger in the deployment package. This coverage is computed for each class and trigger individually and is different than the overall coverage percentage.\n\n- RunLocalTests — All tests in your org are run, except the ones that originate from installed managed and unlocked packages. This test level is the default for production deployments that include Apex classes or triggers.\n\n- RunAllTestsInOrg — All tests in your org are run, including tests of managed packages.\n\nIf you don’t specify a test level, the default behavior depends on the contents of your deployment package. For more information, see the section \"Running Tests in a Deployment\" in the \"Metadata API Developer Guide\". (https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_deploy_running_tests.htm)",
3109
+ "name": "test-level",
3110
+ "summary": "Deployment Apex testing level.",
3271
3111
  "hasDynamicHelp": false,
3272
3112
  "multiple": false,
3113
+ "options": [
3114
+ "NoTestRun",
3115
+ "RunSpecifiedTests",
3116
+ "RunLocalTests",
3117
+ "RunAllTestsInOrg"
3118
+ ],
3119
+ "type": "option"
3120
+ },
3121
+ "tests": {
3122
+ "description": "Separate multiple test names with commas. Enclose the entire flag value in double quotes if a test name contains spaces.",
3123
+ "name": "tests",
3124
+ "summary": "Apex tests to run when --test-level is RunSpecifiedTests.",
3125
+ "hasDynamicHelp": false,
3126
+ "multiple": true,
3273
3127
  "type": "option"
3274
3128
  }
3275
3129
  },
3276
3130
  "hasDynamicHelp": true,
3277
3131
  "hiddenAliases": [],
3278
- "id": "devops:request:status",
3132
+ "id": "devops:promotion:complete",
3279
3133
  "pluginAlias": "@salesforce/plugin-devops-center",
3280
3134
  "pluginName": "@salesforce/plugin-devops-center",
3281
3135
  "pluginType": "jit",
3282
3136
  "strict": true,
3283
- "summary": "Get the status of a request.",
3137
+ "summary": "Deploy undeployed work items to a pipeline stage org.",
3284
3138
  "enableJsonFlag": true,
3285
3139
  "isESM": true,
3286
3140
  "relativePath": [
3287
3141
  "lib",
3288
3142
  "commands",
3289
3143
  "devops",
3290
- "request",
3291
- "status.js"
3144
+ "promotion",
3145
+ "complete.js"
3292
3146
  ]
3293
3147
  },
3294
- "devops:review:create": {
3148
+ "devops:promotion:validate": {
3295
3149
  "aliases": [],
3296
3150
  "args": {},
3297
- "description": "Creates a pull request via the Salesforce DevOps Center API, using the VCS credentials stored in the org. Works with GitHub and Bitbucket without requiring local VCS authentication.",
3151
+ "description": "Validates whether the specified work items can be promoted to the target pipeline stage. Checks for VCS and object permission errors before a promotion is attempted.",
3152
+ "examples": [
3153
+ "Validate promotion of a work item to a target stage:\n<%= config.bin %> <%= command.id %> --target-org my-devops-org --target-stage-id 1QV000000000001 --work-item-id 1fk000000000001",
3154
+ "Validate promotion of multiple work items:\n<%= config.bin %> <%= command.id %> --target-org my-devops-org --target-stage-id 1QV000000000001 --work-item-id 1fk000000000001 --work-item-id 1fk000000000002"
3155
+ ],
3156
+ "flags": {
3157
+ "json": {
3158
+ "description": "Format output as json.",
3159
+ "helpGroup": "GLOBAL",
3160
+ "name": "json",
3161
+ "allowNo": false,
3162
+ "type": "boolean"
3163
+ },
3164
+ "flags-dir": {
3165
+ "helpGroup": "GLOBAL",
3166
+ "name": "flags-dir",
3167
+ "summary": "Import flag values from a directory.",
3168
+ "hasDynamicHelp": false,
3169
+ "multiple": false,
3170
+ "type": "option"
3171
+ },
3172
+ "target-org": {
3173
+ "char": "o",
3174
+ "name": "target-org",
3175
+ "noCacheDefault": true,
3176
+ "required": true,
3177
+ "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
3178
+ "hasDynamicHelp": true,
3179
+ "multiple": false,
3180
+ "type": "option"
3181
+ },
3182
+ "api-version": {
3183
+ "description": "Override the api version used for api requests made by this command",
3184
+ "name": "api-version",
3185
+ "hasDynamicHelp": false,
3186
+ "multiple": false,
3187
+ "type": "option"
3188
+ },
3189
+ "target-stage-id": {
3190
+ "char": "t",
3191
+ "name": "target-stage-id",
3192
+ "required": true,
3193
+ "summary": "ID of the target pipeline stage to validate promotion to.",
3194
+ "hasDynamicHelp": false,
3195
+ "multiple": false,
3196
+ "type": "option"
3197
+ },
3198
+ "work-item-id": {
3199
+ "char": "i",
3200
+ "name": "work-item-id",
3201
+ "required": true,
3202
+ "summary": "ID of a work item to validate for promotion. Specify multiple times for multiple work items.",
3203
+ "hasDynamicHelp": false,
3204
+ "multiple": true,
3205
+ "type": "option"
3206
+ }
3207
+ },
3208
+ "hasDynamicHelp": true,
3209
+ "hiddenAliases": [],
3210
+ "id": "devops:promotion:validate",
3211
+ "pluginAlias": "@salesforce/plugin-devops-center",
3212
+ "pluginName": "@salesforce/plugin-devops-center",
3213
+ "pluginType": "jit",
3214
+ "strict": true,
3215
+ "summary": "Validate work item promotion for a pipeline stage.",
3216
+ "enableJsonFlag": true,
3217
+ "isESM": true,
3218
+ "relativePath": [
3219
+ "lib",
3220
+ "commands",
3221
+ "devops",
3222
+ "promotion",
3223
+ "validate.js"
3224
+ ]
3225
+ },
3226
+ "devops:review:create": {
3227
+ "aliases": [],
3228
+ "args": {},
3229
+ "description": "Creates a pull request via the Salesforce DevOps Center API, using the VCS credentials stored in the org. Works with GitHub and Bitbucket without requiring local VCS authentication.",
3298
3230
  "examples": [
3299
3231
  "Create a pull request for a work item.\n<%= config.bin %> <%= command.id %> --target-org my-devops-org --work-item-name WI-000001",
3300
3232
  "Create a pull request using the work item ID.\n<%= config.bin %> <%= command.id %> --target-org my-devops-org --work-item-id 0Wx000000000001"
@@ -3367,6 +3299,74 @@
3367
3299
  "create.js"
3368
3300
  ]
3369
3301
  },
3302
+ "devops:request:status": {
3303
+ "aliases": [],
3304
+ "args": {},
3305
+ "description": "Returns the current status of a request identified by its request token.",
3306
+ "examples": [
3307
+ "Get the status of a request:\n<%= config.bin %> <%= command.id %> --target-org my-devops-org --request-token a0B000000000001"
3308
+ ],
3309
+ "flags": {
3310
+ "json": {
3311
+ "description": "Format output as json.",
3312
+ "helpGroup": "GLOBAL",
3313
+ "name": "json",
3314
+ "allowNo": false,
3315
+ "type": "boolean"
3316
+ },
3317
+ "flags-dir": {
3318
+ "helpGroup": "GLOBAL",
3319
+ "name": "flags-dir",
3320
+ "summary": "Import flag values from a directory.",
3321
+ "hasDynamicHelp": false,
3322
+ "multiple": false,
3323
+ "type": "option"
3324
+ },
3325
+ "target-org": {
3326
+ "char": "o",
3327
+ "name": "target-org",
3328
+ "noCacheDefault": true,
3329
+ "required": true,
3330
+ "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
3331
+ "hasDynamicHelp": true,
3332
+ "multiple": false,
3333
+ "type": "option"
3334
+ },
3335
+ "api-version": {
3336
+ "description": "Override the api version used for api requests made by this command",
3337
+ "name": "api-version",
3338
+ "hasDynamicHelp": false,
3339
+ "multiple": false,
3340
+ "type": "option"
3341
+ },
3342
+ "request-token": {
3343
+ "char": "i",
3344
+ "name": "request-token",
3345
+ "required": true,
3346
+ "summary": "Request token from the promote response.",
3347
+ "hasDynamicHelp": false,
3348
+ "multiple": false,
3349
+ "type": "option"
3350
+ }
3351
+ },
3352
+ "hasDynamicHelp": true,
3353
+ "hiddenAliases": [],
3354
+ "id": "devops:request:status",
3355
+ "pluginAlias": "@salesforce/plugin-devops-center",
3356
+ "pluginName": "@salesforce/plugin-devops-center",
3357
+ "pluginType": "jit",
3358
+ "strict": true,
3359
+ "summary": "Get the status of a request.",
3360
+ "enableJsonFlag": true,
3361
+ "isESM": true,
3362
+ "relativePath": [
3363
+ "lib",
3364
+ "commands",
3365
+ "devops",
3366
+ "request",
3367
+ "status.js"
3368
+ ]
3369
+ },
3370
3370
  "devops:work-item:combine": {
3371
3371
  "aliases": [],
3372
3372
  "args": {},
@@ -3788,12 +3788,13 @@
3788
3788
  "update.js"
3789
3789
  ]
3790
3790
  },
3791
- "devops:pipeline:project:add": {
3791
+ "project:deploy:pipeline:quick": {
3792
3792
  "aliases": [],
3793
3793
  "args": {},
3794
- "description": "You can attach a project to only one pipeline.",
3794
+ "description": "The first time you run any \"project deploy pipeline\" command, be sure to authorize the org in which DevOps Center is installed. The easiest way to authorize an org is with the \"org login web\" command.\n\nBefore you run this command, create a validated deployment with the \"project deploy pipeline validate\" command, which returns a job ID. Validated deployments haven't been deployed to the org yet; you deploy them with this command. Either pass the job ID to this command or use the --use-most-recent flag to use the job ID of the most recently validated deployment. For the quick deploy to succeed, the associated validated deployment must also have succeeded.\n\nExecuting this quick deploy command takes less time than a standard deploy because it skips running Apex tests. These tests were previously run as part of the validation. Validating first and then running a quick deploy is useful if the deployment to your production org take several hours and you don’t want to risk a failed deploy.\n\nThis command doesn't support source-tracking. The source you deploy overwrites the corresponding metadata in your org. This command doesn’t attempt to merge your source with the versions in your org.",
3795
3795
  "examples": [
3796
- "Attach a project to a pipeline using the project ID and pipeline ID.\n<%= config.bin %> <%= command.id %> --target-org my-devops-org --pipeline-id 0XB000000000001 --project-id 0Hn000000000001"
3796
+ "Run a quick deploy using your default Devops Center org and a job ID:\n<%= config.bin %> <%= command.id %> --job-id 0Af0x000017yLUFCA2",
3797
+ "Asynchronously run a quick deploy of the most recently validated deployment using an org with alias \"my-prod-org\":\n<%= config.bin %> <%= command.id %> --async --use-most-recent --devops-center-username my-prod-org"
3797
3798
  ],
3798
3799
  "flags": {
3799
3800
  "json": {
@@ -3811,65 +3812,96 @@
3811
3812
  "multiple": false,
3812
3813
  "type": "option"
3813
3814
  },
3814
- "target-org": {
3815
- "char": "o",
3816
- "name": "target-org",
3817
- "noCacheDefault": true,
3818
- "required": true,
3819
- "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
3820
- "hasDynamicHelp": true,
3821
- "multiple": false,
3822
- "type": "option"
3815
+ "async": {
3816
+ "description": "The command immediately returns the job ID and control of the terminal to you. This way, you can continue to use the CLI. To resume the deployment, run \"sf project deploy pipeline resume\". To check the status of the deployment, run \"sf project deploy pipeline report\".",
3817
+ "name": "async",
3818
+ "summary": "Run the command asynchronously.",
3819
+ "allowNo": false,
3820
+ "type": "boolean"
3823
3821
  },
3824
- "api-version": {
3825
- "description": "Override the api version used for api requests made by this command",
3826
- "name": "api-version",
3827
- "hasDynamicHelp": false,
3822
+ "concise": {
3823
+ "exclusive": [
3824
+ "verbose"
3825
+ ],
3826
+ "name": "concise",
3827
+ "summary": "Show concise output of the command result.",
3828
+ "allowNo": false,
3829
+ "type": "boolean"
3830
+ },
3831
+ "verbose": {
3832
+ "name": "verbose",
3833
+ "summary": "Show verbose output of the command result.",
3834
+ "allowNo": false,
3835
+ "type": "boolean"
3836
+ },
3837
+ "wait": {
3838
+ "char": "w",
3839
+ "description": "If the command continues to run after the wait period, the CLI returns control of the terminal window to you and returns the job ID. To check the status of the operation, run \"sf project deploy pipeline report\".",
3840
+ "exclusive": [
3841
+ "async"
3842
+ ],
3843
+ "name": "wait",
3844
+ "summary": "Number of minutes to wait for command to complete and display results.",
3845
+ "default": "33 minutes",
3846
+ "hasDynamicHelp": true,
3847
+ "helpValue": "<minutes>",
3828
3848
  "multiple": false,
3829
3849
  "type": "option"
3830
3850
  },
3831
- "pipeline-id": {
3832
- "name": "pipeline-id",
3851
+ "devops-center-username": {
3852
+ "char": "c",
3853
+ "name": "devops-center-username",
3833
3854
  "required": true,
3834
- "summary": "ID of the pipeline.",
3835
- "hasDynamicHelp": false,
3855
+ "summary": "Username or alias of the DevOps Center org.",
3856
+ "hasDynamicHelp": true,
3836
3857
  "multiple": false,
3837
3858
  "type": "option"
3838
3859
  },
3839
- "project-id": {
3840
- "name": "project-id",
3841
- "required": true,
3842
- "summary": "ID of the DevOps Center project.",
3860
+ "job-id": {
3861
+ "char": "i",
3862
+ "description": "The job ID is valid for 10 days from when you started the validation.",
3863
+ "name": "job-id",
3864
+ "summary": "Job ID of the validated deployment to quick deploy.",
3843
3865
  "hasDynamicHelp": false,
3844
3866
  "multiple": false,
3845
3867
  "type": "option"
3868
+ },
3869
+ "use-most-recent": {
3870
+ "char": "r",
3871
+ "description": "For performance reasons, this flag uses only job IDs that were validated in the past 3 days or less. If your most recent deployment validation was more than 3 days ago, this flag won't find the job ID.",
3872
+ "name": "use-most-recent",
3873
+ "summary": "Use the job ID of the most recently validated deployment.",
3874
+ "allowNo": false,
3875
+ "type": "boolean"
3846
3876
  }
3847
3877
  },
3848
3878
  "hasDynamicHelp": true,
3849
3879
  "hiddenAliases": [],
3850
- "id": "devops:pipeline:project:add",
3880
+ "id": "project:deploy:pipeline:quick",
3851
3881
  "pluginAlias": "@salesforce/plugin-devops-center",
3852
3882
  "pluginName": "@salesforce/plugin-devops-center",
3853
3883
  "pluginType": "jit",
3884
+ "state": "beta",
3854
3885
  "strict": true,
3855
- "summary": "Attach a DevOps Center project to a pipeline.",
3886
+ "summary": "Quickly deploy a validated deployment to an org.",
3856
3887
  "enableJsonFlag": true,
3857
3888
  "isESM": true,
3858
3889
  "relativePath": [
3859
3890
  "lib",
3860
3891
  "commands",
3861
- "devops",
3862
- "pipeline",
3863
3892
  "project",
3864
- "add.js"
3893
+ "deploy",
3894
+ "pipeline",
3895
+ "quick.js"
3865
3896
  ]
3866
3897
  },
3867
- "devops:pipeline:project:delete": {
3898
+ "project:deploy:pipeline:report": {
3868
3899
  "aliases": [],
3869
3900
  "args": {},
3870
- "description": "Deletes the junction record that connects the project to the pipeline. The project itself is not deleted.",
3901
+ "description": "The first time you run any \"project deploy pipeline\" command, be sure to authorize the org in which DevOps Center is installed. The easiest way to authorize an org is with the \"org login web\" command.\n\nRun this command by either indicating a job ID or specifying the —use-most-recent flag to use the job ID of the most recent deploy operation.",
3871
3902
  "examples": [
3872
- "Remove a project from a pipeline using the project ID and pipeline ID.\n<%= config.bin %> <%= command.id %> --target-org my-devops-org --pipeline-id 0XB000000000001 --project-id 0Hn000000000001"
3903
+ "Check the status using a job ID:\n<%= config.bin %> <%= command.id %> --devops-center-username MyStagingSandbox --job-id 0Af0x000017yLUFCA2",
3904
+ "Check the status of the most recent deploy operation:\n<%= config.bin %> <%= command.id %> --devops-center-username MyStagingSandbox --use-most-recent"
3873
3905
  ],
3874
3906
  "flags": {
3875
3907
  "json": {
@@ -3887,66 +3919,60 @@
3887
3919
  "multiple": false,
3888
3920
  "type": "option"
3889
3921
  },
3890
- "target-org": {
3891
- "char": "o",
3892
- "name": "target-org",
3893
- "noCacheDefault": true,
3922
+ "devops-center-username": {
3923
+ "char": "c",
3924
+ "name": "devops-center-username",
3894
3925
  "required": true,
3895
- "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
3926
+ "summary": "Username or alias of the DevOps Center org.",
3896
3927
  "hasDynamicHelp": true,
3897
3928
  "multiple": false,
3898
3929
  "type": "option"
3899
3930
  },
3900
- "api-version": {
3901
- "description": "Override the api version used for api requests made by this command",
3902
- "name": "api-version",
3903
- "hasDynamicHelp": false,
3904
- "multiple": false,
3905
- "type": "option"
3906
- },
3907
- "pipeline-id": {
3908
- "name": "pipeline-id",
3909
- "required": true,
3910
- "summary": "ID of the pipeline.",
3931
+ "job-id": {
3932
+ "char": "i",
3933
+ "description": "The job ID is valid for 10 days from when you started the deploy operation.",
3934
+ "name": "job-id",
3935
+ "summary": "Job ID of the pipeline deployment to check the status of.",
3911
3936
  "hasDynamicHelp": false,
3912
3937
  "multiple": false,
3913
3938
  "type": "option"
3914
3939
  },
3915
- "project-id": {
3916
- "name": "project-id",
3917
- "required": true,
3918
- "summary": "ID of the DevOps Center project.",
3919
- "hasDynamicHelp": false,
3920
- "multiple": false,
3921
- "type": "option"
3940
+ "use-most-recent": {
3941
+ "char": "r",
3942
+ "description": "For performance reasons, this flag uses job IDs for deploy operations that started in the past 3 days or fewer. If your most recent operation was longer than 3 days ago, this flag won't find the job ID.",
3943
+ "name": "use-most-recent",
3944
+ "summary": "Use the job ID of the most recent deploy operation.",
3945
+ "allowNo": false,
3946
+ "type": "boolean"
3922
3947
  }
3923
3948
  },
3924
3949
  "hasDynamicHelp": true,
3925
3950
  "hiddenAliases": [],
3926
- "id": "devops:pipeline:project:delete",
3951
+ "id": "project:deploy:pipeline:report",
3927
3952
  "pluginAlias": "@salesforce/plugin-devops-center",
3928
3953
  "pluginName": "@salesforce/plugin-devops-center",
3929
3954
  "pluginType": "jit",
3955
+ "state": "beta",
3930
3956
  "strict": true,
3931
- "summary": "Remove a DevOps Center project's connection to a pipeline.",
3957
+ "summary": "Check the status of a pipeline deploy operation.",
3932
3958
  "enableJsonFlag": true,
3933
3959
  "isESM": true,
3934
3960
  "relativePath": [
3935
3961
  "lib",
3936
3962
  "commands",
3937
- "devops",
3938
- "pipeline",
3939
3963
  "project",
3940
- "delete.js"
3964
+ "deploy",
3965
+ "pipeline",
3966
+ "report.js"
3941
3967
  ]
3942
3968
  },
3943
- "devops:pipeline:stage:add": {
3969
+ "project:deploy:pipeline:resume": {
3944
3970
  "aliases": [],
3945
3971
  "args": {},
3946
- "description": "Inserts an empty stage before the stage specified by `--next-stage-id`. The new stage doesn't include a branch or environment. Configure them separately after you create the stage.",
3972
+ "description": "The first time you run any \"project deploy pipeline\" command, be sure to authorize the org in which DevOps Center is installed. The easiest way to authorize an org is with the \"org login web\" command. \n\nUse this command to resume watching a pipeline deploy operation if the original command times out or you specified the --async flag.\n\nRun this command by either indicating a job ID or specifying the --use-most-recent flag to use the job ID of the most recent deploy operation.",
3947
3973
  "examples": [
3948
- "Add a Development stage before Integration in a specific pipeline.\n<%= config.bin %> <%= command.id %> --target-org my-devops-org --pipeline-id 0XB000000000001 --name \"Development\" --next-stage-id 0Xc000000000002",
3949
- "Add a QA stage before UAT in a specific pipeline.\n<%= config.bin %> <%= command.id %> --target-org my-devops-org --pipeline-id 0XB000000000001 --name \"QA\" --next-stage-id 0Xc000000000003"
3974
+ "Resume watching a deploy operation using a job ID:\n<%= config.bin %> <%= command.id %> --job-id 0Af0x000017yLUFCA2",
3975
+ "Resume watching the most recent deploy operation:\n<%= config.bin %> <%= command.id %> --use-most-recent"
3950
3976
  ],
3951
3977
  "flags": {
3952
3978
  "json": {
@@ -3964,74 +3990,89 @@
3964
3990
  "multiple": false,
3965
3991
  "type": "option"
3966
3992
  },
3967
- "target-org": {
3968
- "char": "o",
3969
- "name": "target-org",
3970
- "noCacheDefault": true,
3993
+ "devops-center-username": {
3994
+ "char": "c",
3995
+ "name": "devops-center-username",
3971
3996
  "required": true,
3972
- "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
3997
+ "summary": "Username or alias of the DevOps Center org.",
3973
3998
  "hasDynamicHelp": true,
3974
3999
  "multiple": false,
3975
4000
  "type": "option"
3976
4001
  },
3977
- "api-version": {
3978
- "description": "Override the api version used for api requests made by this command",
3979
- "name": "api-version",
4002
+ "job-id": {
4003
+ "char": "i",
4004
+ "description": "These commands return a job ID if they time out or you specified the --async flag:\n\n- sf project deploy pipeline start\n- sf project deploy pipeline validate\n- sf project deploy pipeline quick\n\nThe job ID is valid for 10 days from when you started the deploy operation.",
4005
+ "name": "job-id",
4006
+ "summary": "Job ID of the pipeline deploy operation you want to resume.",
3980
4007
  "hasDynamicHelp": false,
3981
4008
  "multiple": false,
3982
4009
  "type": "option"
3983
4010
  },
3984
- "pipeline-id": {
3985
- "name": "pipeline-id",
3986
- "required": true,
3987
- "summary": "ID of the pipeline where the stage is added.",
3988
- "hasDynamicHelp": false,
3989
- "multiple": false,
3990
- "type": "option"
4011
+ "use-most-recent": {
4012
+ "char": "r",
4013
+ "description": "For performance reasons, this flag uses job IDs for operations that started in the past 3 days or fewer. If your most recent operation was longer than 3 days ago, this flag won't find a job ID.",
4014
+ "name": "use-most-recent",
4015
+ "summary": "Use the job ID of the most recent deploy operation.",
4016
+ "allowNo": false,
4017
+ "type": "boolean"
3991
4018
  },
3992
- "name": {
3993
- "char": "n",
3994
- "name": "name",
3995
- "required": true,
3996
- "summary": "Name of the pipeline stage, such as Integration, UAT, or Staging.",
3997
- "hasDynamicHelp": false,
3998
- "multiple": false,
3999
- "type": "option"
4019
+ "concise": {
4020
+ "exclusive": [
4021
+ "verbose"
4022
+ ],
4023
+ "name": "concise",
4024
+ "summary": "Show concise output of the command result.",
4025
+ "allowNo": false,
4026
+ "type": "boolean"
4000
4027
  },
4001
- "next-stage-id": {
4002
- "name": "next-stage-id",
4003
- "required": true,
4004
- "summary": "ID of the stage that follows the new stage in the pipeline.",
4005
- "hasDynamicHelp": false,
4028
+ "verbose": {
4029
+ "name": "verbose",
4030
+ "summary": "Show verbose output of the command result.",
4031
+ "allowNo": false,
4032
+ "type": "boolean"
4033
+ },
4034
+ "wait": {
4035
+ "char": "w",
4036
+ "description": "If the command continues to run after the wait period, the CLI returns control of the terminal window to you and returns the job ID. To check the status of the operation, run \"sf project deploy pipeline report\".",
4037
+ "exclusive": [
4038
+ "async"
4039
+ ],
4040
+ "name": "wait",
4041
+ "summary": "Number of minutes to wait for command to complete and display results.",
4042
+ "default": "33 minutes",
4043
+ "hasDynamicHelp": true,
4044
+ "helpValue": "<minutes>",
4006
4045
  "multiple": false,
4007
4046
  "type": "option"
4008
4047
  }
4009
4048
  },
4010
4049
  "hasDynamicHelp": true,
4011
4050
  "hiddenAliases": [],
4012
- "id": "devops:pipeline:stage:add",
4051
+ "id": "project:deploy:pipeline:resume",
4013
4052
  "pluginAlias": "@salesforce/plugin-devops-center",
4014
4053
  "pluginName": "@salesforce/plugin-devops-center",
4015
4054
  "pluginType": "jit",
4055
+ "state": "beta",
4016
4056
  "strict": true,
4017
- "summary": "Add a stage to a DevOps Center pipeline.",
4057
+ "summary": "Resume watching a pipeline deploy operation.",
4018
4058
  "enableJsonFlag": true,
4019
4059
  "isESM": true,
4020
4060
  "relativePath": [
4021
4061
  "lib",
4022
4062
  "commands",
4023
- "devops",
4063
+ "project",
4064
+ "deploy",
4024
4065
  "pipeline",
4025
- "stage",
4026
- "add.js"
4066
+ "resume.js"
4027
4067
  ]
4028
4068
  },
4029
- "devops:pipeline:stage:delete": {
4069
+ "project:deploy:pipeline:start": {
4030
4070
  "aliases": [],
4031
4071
  "args": {},
4032
- "description": "Deletes the specified stage from the pipeline. If the stage sits between two other stages, the predecessor stage is automatically re-linked to the successor so the pipeline chain stays intact.",
4072
+ "description": "The first time you run any \"project deploy pipeline\" command, be sure to authorize the org in which DevOps Center is installed. The easiest way to authorize an org is with the \"org login web\" command.\n\nBefore you run this command, changes in the pipeline stage's branch must be merged in the source control repository.",
4033
4073
  "examples": [
4034
- "Delete a stage from a pipeline:\n<%= config.bin %> <%= command.id %> --target-org my-devops-org --pipeline-id 0XB000000000001 --stage-id 0Xc000000000002"
4074
+ "Deploy changes in the Staging branch to the Staging environment (sandbox), if the previous stage is the bundling stage:\n<%= config.bin %> <%= command.id %> --devops-center-project-name “Recruiting App” --branch-name staging --devops-center-username MyStagingSandbox --bundle-version-name 1.0",
4075
+ "Deploy all changes in the main branch to the release environment:\n<%= config.bin %> <%= command.id %> --devops-center-project-name “Recruiting App” --branch-name main --devops-center-username MyReleaseOrg --deploy-all"
4035
4076
  ],
4036
4077
  "flags": {
4037
4078
  "json": {
@@ -4049,65 +4090,138 @@
4049
4090
  "multiple": false,
4050
4091
  "type": "option"
4051
4092
  },
4052
- "target-org": {
4053
- "char": "o",
4054
- "name": "target-org",
4055
- "noCacheDefault": true,
4093
+ "branch-name": {
4094
+ "char": "b",
4095
+ "name": "branch-name",
4056
4096
  "required": true,
4057
- "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
4058
- "hasDynamicHelp": true,
4097
+ "summary": "Name of the branch in the source control repository that corresponds to the pipeline stage that you want to deploy the changes to.",
4098
+ "hasDynamicHelp": false,
4059
4099
  "multiple": false,
4060
4100
  "type": "option"
4061
4101
  },
4062
- "api-version": {
4063
- "description": "Override the api version used for api requests made by this command",
4064
- "name": "api-version",
4102
+ "bundle-version-name": {
4103
+ "char": "v",
4104
+ "description": "You must indicate the bundle version if deploying to the environment that corresponds to the first stage after the bundling stage.",
4105
+ "name": "bundle-version-name",
4106
+ "summary": "Version name of the bundle.",
4065
4107
  "hasDynamicHelp": false,
4066
4108
  "multiple": false,
4067
4109
  "type": "option"
4068
4110
  },
4069
- "pipeline-id": {
4070
- "name": "pipeline-id",
4111
+ "deploy-all": {
4112
+ "char": "a",
4113
+ "description": "If you don’t specify this flag, only changes in the stage’s branch are deployed.",
4114
+ "name": "deploy-all",
4115
+ "summary": "Deploy all metadata in the branch to the stage's org.",
4116
+ "allowNo": false,
4117
+ "type": "boolean"
4118
+ },
4119
+ "devops-center-project-name": {
4120
+ "char": "p",
4121
+ "name": "devops-center-project-name",
4071
4122
  "required": true,
4072
- "summary": "ID of the pipeline that contains the stage.",
4123
+ "summary": "Name of the DevOps Center project.",
4073
4124
  "hasDynamicHelp": false,
4074
4125
  "multiple": false,
4075
4126
  "type": "option"
4076
4127
  },
4077
- "stage-id": {
4078
- "name": "stage-id",
4128
+ "devops-center-username": {
4129
+ "char": "c",
4130
+ "name": "devops-center-username",
4079
4131
  "required": true,
4080
- "summary": "ID of the stage to delete.",
4132
+ "summary": "Username or alias of the DevOps Center org.",
4133
+ "hasDynamicHelp": true,
4134
+ "multiple": false,
4135
+ "type": "option"
4136
+ },
4137
+ "tests": {
4138
+ "char": "t",
4139
+ "description": "Separate multiple test names with commas. Enclose the entire flag value in double quotes if a test name contains spaces.",
4140
+ "name": "tests",
4141
+ "summary": "Apex tests to run when --test-level is RunSpecifiedTests.",
4142
+ "hasDynamicHelp": false,
4143
+ "multiple": true,
4144
+ "type": "option"
4145
+ },
4146
+ "test-level": {
4147
+ "char": "l",
4148
+ "description": "Valid values are:\n\n- NoTestRun — No tests are run. This test level applies only to deployments to development environments, such as sandbox, Developer Edition, or trial orgs. This test level is the default for development environments.\n\n- RunSpecifiedTests — Runs only the tests that you specify with the --tests flag. Code coverage requirements differ from the default coverage requirements when using this test level. Executed tests must comprise a minimum of 75% code coverage for each class and trigger in the deployment package. This coverage is computed for each class and trigger individually and is different than the overall coverage percentage.\n\n- RunLocalTests — All tests in your org are run, except the ones that originate from installed managed and unlocked packages. This test level is the default for production deployments that include Apex classes or triggers.\n\n- RunAllTestsInOrg — All tests in your org are run, including tests of managed packages.\n\nIf you don’t specify a test level, the default behavior depends on the contents of your deployment package. For more information, see the section \"Running Tests in a Deployment\" in the \"Metadata API Developer Guide\". (https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_deploy_running_tests.htm)",
4149
+ "name": "test-level",
4150
+ "summary": "Deployment Apex testing level.",
4081
4151
  "hasDynamicHelp": false,
4082
4152
  "multiple": false,
4153
+ "options": [
4154
+ "NoTestRun",
4155
+ "RunSpecifiedTests",
4156
+ "RunLocalTests",
4157
+ "RunAllTestsInOrg"
4158
+ ],
4159
+ "type": "option"
4160
+ },
4161
+ "async": {
4162
+ "description": "The command immediately returns the job ID and control of the terminal to you. This way, you can continue to use the CLI. To resume the deployment, run \"sf project deploy pipeline resume\". To check the status of the deployment, run \"sf project deploy pipeline report\".",
4163
+ "name": "async",
4164
+ "summary": "Run the command asynchronously.",
4165
+ "allowNo": false,
4166
+ "type": "boolean"
4167
+ },
4168
+ "wait": {
4169
+ "char": "w",
4170
+ "description": "If the command continues to run after the wait period, the CLI returns control of the terminal window to you and returns the job ID. To check the status of the operation, run \"sf project deploy pipeline report\".",
4171
+ "exclusive": [
4172
+ "async"
4173
+ ],
4174
+ "name": "wait",
4175
+ "summary": "Number of minutes to wait for command to complete and display results.",
4176
+ "default": "33 minutes",
4177
+ "hasDynamicHelp": true,
4178
+ "helpValue": "<minutes>",
4179
+ "multiple": false,
4083
4180
  "type": "option"
4181
+ },
4182
+ "verbose": {
4183
+ "name": "verbose",
4184
+ "summary": "Show verbose output of the command result.",
4185
+ "allowNo": false,
4186
+ "type": "boolean"
4187
+ },
4188
+ "concise": {
4189
+ "exclusive": [
4190
+ "verbose"
4191
+ ],
4192
+ "name": "concise",
4193
+ "summary": "Show concise output of the command result.",
4194
+ "allowNo": false,
4195
+ "type": "boolean"
4084
4196
  }
4085
4197
  },
4086
4198
  "hasDynamicHelp": true,
4087
4199
  "hiddenAliases": [],
4088
- "id": "devops:pipeline:stage:delete",
4200
+ "id": "project:deploy:pipeline:start",
4089
4201
  "pluginAlias": "@salesforce/plugin-devops-center",
4090
4202
  "pluginName": "@salesforce/plugin-devops-center",
4091
4203
  "pluginType": "jit",
4204
+ "state": "beta",
4092
4205
  "strict": true,
4093
- "summary": "Delete a stage from a DevOps Center pipeline.",
4206
+ "summary": "Deploy changes from a branch to the pipeline stage’s org.",
4094
4207
  "enableJsonFlag": true,
4095
4208
  "isESM": true,
4096
4209
  "relativePath": [
4097
4210
  "lib",
4098
4211
  "commands",
4099
- "devops",
4212
+ "project",
4213
+ "deploy",
4100
4214
  "pipeline",
4101
- "stage",
4102
- "delete.js"
4215
+ "start.js"
4103
4216
  ]
4104
4217
  },
4105
- "devops:pipeline:stage:update": {
4218
+ "project:deploy:pipeline:validate": {
4106
4219
  "aliases": [],
4107
4220
  "args": {},
4108
- "description": "Updates the name of a pipeline stage.",
4221
+ "description": "The first time you run any \"project deploy pipeline\" command, be sure to authorize the org in which DevOps Center is installed. The easiest way to authorize an org is with the \"org login web\" command.\n\nA validation runs Apex tests to verify whether a deployment will succeed without actually deploying the metadata to your environment, so you can then quickly deploy the changes later without re-running the tests.",
4109
4222
  "examples": [
4110
- "Rename a pipeline stage.\n<%= config.bin %> <%= command.id %> --target-org my-devops-org --stage-id 1QV000000000001 --name \"Integration\""
4223
+ "Perform a validate-only deployment from the Staging branch to the Staging environment (sandbox):\n<%= config.bin %> <%= command.id %> --devops-center-project-name “Recruiting App” --branch-name staging --devops-center-username MyStagingSandbox",
4224
+ "Perform a validate-only deployment of all changes from the main branch to the release environment:\n<%= config.bin %> <%= command.id %> --devops-center-project-name “Recruiting App” --branch-name main --devops-center-username MyReleaseOrg --deploy-all"
4111
4225
  ],
4112
4226
  "flags": {
4113
4227
  "json": {
@@ -4125,68 +4239,137 @@
4125
4239
  "multiple": false,
4126
4240
  "type": "option"
4127
4241
  },
4128
- "target-org": {
4129
- "char": "o",
4130
- "name": "target-org",
4131
- "noCacheDefault": true,
4132
- "required": true,
4133
- "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
4134
- "hasDynamicHelp": true,
4242
+ "branch-name": {
4243
+ "char": "b",
4244
+ "name": "branch-name",
4245
+ "required": true,
4246
+ "summary": "Name of the branch in the source control repository that corresponds to the pipeline stage that you want to deploy the changes to.",
4247
+ "hasDynamicHelp": false,
4135
4248
  "multiple": false,
4136
4249
  "type": "option"
4137
4250
  },
4138
- "api-version": {
4139
- "description": "Override the api version used for api requests made by this command",
4140
- "name": "api-version",
4251
+ "bundle-version-name": {
4252
+ "char": "v",
4253
+ "description": "You must indicate the bundle version if deploying to the environment that corresponds to the first stage after the bundling stage.",
4254
+ "name": "bundle-version-name",
4255
+ "summary": "Version name of the bundle.",
4141
4256
  "hasDynamicHelp": false,
4142
4257
  "multiple": false,
4143
4258
  "type": "option"
4144
4259
  },
4145
- "stage-id": {
4146
- "char": "s",
4147
- "name": "stage-id",
4260
+ "deploy-all": {
4261
+ "char": "a",
4262
+ "description": "If you don’t specify this flag, only changes in the stage’s branch are deployed.",
4263
+ "name": "deploy-all",
4264
+ "summary": "Deploy all metadata in the branch to the stage's org.",
4265
+ "allowNo": false,
4266
+ "type": "boolean"
4267
+ },
4268
+ "devops-center-project-name": {
4269
+ "char": "p",
4270
+ "name": "devops-center-project-name",
4148
4271
  "required": true,
4149
- "summary": "ID of the pipeline stage to update.",
4272
+ "summary": "Name of the DevOps Center project.",
4150
4273
  "hasDynamicHelp": false,
4151
4274
  "multiple": false,
4152
4275
  "type": "option"
4153
4276
  },
4154
- "name": {
4155
- "char": "n",
4156
- "name": "name",
4277
+ "devops-center-username": {
4278
+ "char": "c",
4279
+ "name": "devops-center-username",
4157
4280
  "required": true,
4158
- "summary": "New name for the pipeline stage.",
4281
+ "summary": "Username or alias of the DevOps Center org.",
4282
+ "hasDynamicHelp": true,
4283
+ "multiple": false,
4284
+ "type": "option"
4285
+ },
4286
+ "tests": {
4287
+ "char": "t",
4288
+ "description": "Separate multiple test names with commas. Enclose the entire flag value in double quotes if a test name contains spaces.",
4289
+ "name": "tests",
4290
+ "summary": "Apex tests to run when --test-level is RunSpecifiedTests.",
4159
4291
  "hasDynamicHelp": false,
4292
+ "multiple": true,
4293
+ "type": "option"
4294
+ },
4295
+ "test-level": {
4296
+ "char": "l",
4297
+ "description": "Valid values are:\n\n- NoTestRun — No tests are run. This test level applies only to deployments to development environments, such as sandbox, Developer Edition, or trial orgs. This test level is the default for development environments.\n\n- RunSpecifiedTests — Runs only the tests that you specify with the --tests flag. Code coverage requirements differ from the default coverage requirements when using this test level. Executed tests must comprise a minimum of 75% code coverage for each class and trigger in the deployment package. This coverage is computed for each class and trigger individually and is different than the overall coverage percentage.\n\n- RunLocalTests — All tests in your org are run, except the ones that originate from installed managed and unlocked packages. This test level is the default for production deployments that include Apex classes or triggers.\n\n- RunAllTestsInOrg — All tests in your org are run, including tests of managed packages.\n\nIf you don’t specify a test level, the default behavior depends on the contents of your deployment package. For more information, see the section \"Running Tests in a Deployment\" in the \"Metadata API Developer Guide\". (https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_deploy_running_tests.htm)",
4298
+ "name": "test-level",
4299
+ "summary": "Deployment Apex testing level.",
4300
+ "hasDynamicHelp": false,
4301
+ "multiple": false,
4302
+ "options": [
4303
+ "NoTestRun",
4304
+ "RunSpecifiedTests",
4305
+ "RunLocalTests",
4306
+ "RunAllTestsInOrg"
4307
+ ],
4308
+ "type": "option"
4309
+ },
4310
+ "async": {
4311
+ "description": "The command immediately returns the job ID and control of the terminal to you. This way, you can continue to use the CLI. To resume the deployment, run \"sf project deploy pipeline resume\". To check the status of the deployment, run \"sf project deploy pipeline report\".",
4312
+ "name": "async",
4313
+ "summary": "Run the command asynchronously.",
4314
+ "allowNo": false,
4315
+ "type": "boolean"
4316
+ },
4317
+ "wait": {
4318
+ "char": "w",
4319
+ "description": "If the command continues to run after the wait period, the CLI returns control of the terminal window to you and returns the job ID. To check the status of the operation, run \"sf project deploy pipeline report\".",
4320
+ "exclusive": [
4321
+ "async"
4322
+ ],
4323
+ "name": "wait",
4324
+ "summary": "Number of minutes to wait for command to complete and display results.",
4325
+ "default": "33 minutes",
4326
+ "hasDynamicHelp": true,
4327
+ "helpValue": "<minutes>",
4160
4328
  "multiple": false,
4161
4329
  "type": "option"
4330
+ },
4331
+ "verbose": {
4332
+ "name": "verbose",
4333
+ "summary": "Show verbose output of the command result.",
4334
+ "allowNo": false,
4335
+ "type": "boolean"
4336
+ },
4337
+ "concise": {
4338
+ "exclusive": [
4339
+ "verbose"
4340
+ ],
4341
+ "name": "concise",
4342
+ "summary": "Show concise output of the command result.",
4343
+ "allowNo": false,
4344
+ "type": "boolean"
4162
4345
  }
4163
4346
  },
4164
4347
  "hasDynamicHelp": true,
4165
4348
  "hiddenAliases": [],
4166
- "id": "devops:pipeline:stage:update",
4349
+ "id": "project:deploy:pipeline:validate",
4167
4350
  "pluginAlias": "@salesforce/plugin-devops-center",
4168
4351
  "pluginName": "@salesforce/plugin-devops-center",
4169
4352
  "pluginType": "jit",
4353
+ "state": "beta",
4170
4354
  "strict": true,
4171
- "summary": "Update a DevOps Center pipeline stage.",
4355
+ "summary": "Perform a validate-only deployment from a branch to the pipeline stage’s org.",
4172
4356
  "enableJsonFlag": true,
4173
4357
  "isESM": true,
4174
4358
  "relativePath": [
4175
4359
  "lib",
4176
4360
  "commands",
4177
- "devops",
4361
+ "project",
4362
+ "deploy",
4178
4363
  "pipeline",
4179
- "stage",
4180
- "update.js"
4364
+ "validate.js"
4181
4365
  ]
4182
4366
  },
4183
- "devops:stage:branch:add": {
4367
+ "devops:pipeline:project:add": {
4184
4368
  "aliases": [],
4185
4369
  "args": {},
4186
- "description": "By default, the branch must exist in the repository. Use --create-vcs-branch to create a branch if it doesn't exist.\nEach pipeline stage supports only one branch. If the stage already has a branch, the command blocks so the existing branch isn't orphaned; pass --force to replace it.",
4370
+ "description": "You can attach a project to only one pipeline.",
4187
4371
  "examples": [
4188
- "Add an existing branch to a stage:\n<%= config.bin %> <%= command.id %> --target-org my-devops-org --pipeline-id 0Xo000000000001 --stage-id 0Xp000000000001 --branch-name main",
4189
- "Create and add a branch to a pipeline stage:\n<%= config.bin %> <%= command.id %> --target-org my-devops-org --pipeline-id 0Xo000000000001 --stage-id 0Xp000000000002 --branch-name integration --create-vcs-branch"
4372
+ "Attach a project to a pipeline using the project ID and pipeline ID.\n<%= config.bin %> <%= command.id %> --target-org my-devops-org --pipeline-id 0XB000000000001 --project-id 0Hn000000000001"
4190
4373
  ],
4191
4374
  "flags": {
4192
4375
  "json": {
@@ -4224,66 +4407,45 @@
4224
4407
  "pipeline-id": {
4225
4408
  "name": "pipeline-id",
4226
4409
  "required": true,
4227
- "summary": "ID of the pipeline that contains the stage.",
4228
- "hasDynamicHelp": false,
4229
- "multiple": false,
4230
- "type": "option"
4231
- },
4232
- "stage-id": {
4233
- "name": "stage-id",
4234
- "required": true,
4235
- "summary": "ID of the pipeline stage to associate the branch with.",
4410
+ "summary": "ID of the pipeline.",
4236
4411
  "hasDynamicHelp": false,
4237
4412
  "multiple": false,
4238
4413
  "type": "option"
4239
4414
  },
4240
- "branch-name": {
4241
- "char": "b",
4242
- "name": "branch-name",
4415
+ "project-id": {
4416
+ "name": "project-id",
4243
4417
  "required": true,
4244
- "summary": "Name of the repository branch to assign to the stage.",
4418
+ "summary": "ID of the DevOps Center project.",
4245
4419
  "hasDynamicHelp": false,
4246
4420
  "multiple": false,
4247
4421
  "type": "option"
4248
- },
4249
- "create-vcs-branch": {
4250
- "name": "create-vcs-branch",
4251
- "summary": "Create the branch in the remote repository if it doesn't already exist.",
4252
- "allowNo": false,
4253
- "type": "boolean"
4254
- },
4255
- "force": {
4256
- "name": "force",
4257
- "summary": "Replace the stage's existing branch. By default, the command blocks if the stage already has a branch to avoid orphaning it. With this flag, the new branch is associated and the previous branch record is removed if no other stage references it.",
4258
- "allowNo": false,
4259
- "type": "boolean"
4260
4422
  }
4261
4423
  },
4262
4424
  "hasDynamicHelp": true,
4263
4425
  "hiddenAliases": [],
4264
- "id": "devops:stage:branch:add",
4426
+ "id": "devops:pipeline:project:add",
4265
4427
  "pluginAlias": "@salesforce/plugin-devops-center",
4266
4428
  "pluginName": "@salesforce/plugin-devops-center",
4267
4429
  "pluginType": "jit",
4268
4430
  "strict": true,
4269
- "summary": "Add a source code repository branch to a pipeline stage.",
4431
+ "summary": "Attach a DevOps Center project to a pipeline.",
4270
4432
  "enableJsonFlag": true,
4271
4433
  "isESM": true,
4272
4434
  "relativePath": [
4273
4435
  "lib",
4274
4436
  "commands",
4275
4437
  "devops",
4276
- "stage",
4277
- "branch",
4438
+ "pipeline",
4439
+ "project",
4278
4440
  "add.js"
4279
4441
  ]
4280
4442
  },
4281
- "devops:stage:branch:delete": {
4443
+ "devops:pipeline:project:delete": {
4282
4444
  "aliases": [],
4283
4445
  "args": {},
4284
- "description": "Removes the branch linked to the specified pipeline stage. Because branches are configured from right to left (a stage can have a branch only after the stage to its right does), removing a branch also removes the branches from all upstream stages (to the left) in the pipeline, keeping it in a valid state. The branch records in the repository are not deleted; only their association with the stages is removed. The stage must belong to an inactive pipeline.",
4446
+ "description": "Deletes the junction record that connects the project to the pipeline. The project itself is not deleted.",
4285
4447
  "examples": [
4286
- "Delete the branch associated with a pipeline stage:\n<%= config.bin %> <%= command.id %> --target-org my-devops-org --pipeline-id 0Xo000000000001 --stage-id 0Xp000000000001"
4448
+ "Remove a project from a pipeline using the project ID and pipeline ID.\n<%= config.bin %> <%= command.id %> --target-org my-devops-org --pipeline-id 0XB000000000001 --project-id 0Hn000000000001"
4287
4449
  ],
4288
4450
  "flags": {
4289
4451
  "json": {
@@ -4321,15 +4483,15 @@
4321
4483
  "pipeline-id": {
4322
4484
  "name": "pipeline-id",
4323
4485
  "required": true,
4324
- "summary": "ID of the pipeline that contains the stage. Used to verify the pipeline is inactive before deleting.",
4486
+ "summary": "ID of the pipeline.",
4325
4487
  "hasDynamicHelp": false,
4326
4488
  "multiple": false,
4327
4489
  "type": "option"
4328
4490
  },
4329
- "stage-id": {
4330
- "name": "stage-id",
4491
+ "project-id": {
4492
+ "name": "project-id",
4331
4493
  "required": true,
4332
- "summary": "ID of the pipeline stage whose branch you want to delete.",
4494
+ "summary": "ID of the DevOps Center project.",
4333
4495
  "hasDynamicHelp": false,
4334
4496
  "multiple": false,
4335
4497
  "type": "option"
@@ -4337,29 +4499,30 @@
4337
4499
  },
4338
4500
  "hasDynamicHelp": true,
4339
4501
  "hiddenAliases": [],
4340
- "id": "devops:stage:branch:delete",
4502
+ "id": "devops:pipeline:project:delete",
4341
4503
  "pluginAlias": "@salesforce/plugin-devops-center",
4342
4504
  "pluginName": "@salesforce/plugin-devops-center",
4343
4505
  "pluginType": "jit",
4344
4506
  "strict": true,
4345
- "summary": "Delete the source code repository branch associated with a pipeline stage.",
4507
+ "summary": "Remove a DevOps Center project's connection to a pipeline.",
4346
4508
  "enableJsonFlag": true,
4347
4509
  "isESM": true,
4348
4510
  "relativePath": [
4349
4511
  "lib",
4350
4512
  "commands",
4351
4513
  "devops",
4352
- "stage",
4353
- "branch",
4514
+ "pipeline",
4515
+ "project",
4354
4516
  "delete.js"
4355
4517
  ]
4356
4518
  },
4357
- "devops:stage:environment:add": {
4519
+ "devops:pipeline:stage:add": {
4358
4520
  "aliases": [],
4359
4521
  "args": {},
4360
- "description": "This command triggers an OAuth flow to authenticate the environment. A browser window opens automatically for you to log in.",
4522
+ "description": "Inserts an empty stage before the stage specified by `--next-stage-id`. The new stage doesn't include a branch or environment. Configure them separately after you create the stage.",
4361
4523
  "examples": [
4362
- "Add a production environment to a stage using its ID:\n<%= config.bin %> <%= command.id %> --target-org my-devops-org --stage-id 0Xp000000000001 --environment-name Production_Org --org-type Production"
4524
+ "Add a Development stage before Integration in a specific pipeline.\n<%= config.bin %> <%= command.id %> --target-org my-devops-org --pipeline-id 0XB000000000001 --name \"Development\" --next-stage-id 0Xc000000000002",
4525
+ "Add a QA stage before UAT in a specific pipeline.\n<%= config.bin %> <%= command.id %> --target-org my-devops-org --pipeline-id 0XB000000000001 --name \"QA\" --next-stage-id 0Xc000000000003"
4363
4526
  ],
4364
4527
  "flags": {
4365
4528
  "json": {
@@ -4397,78 +4560,54 @@
4397
4560
  "pipeline-id": {
4398
4561
  "name": "pipeline-id",
4399
4562
  "required": true,
4400
- "summary": "ID of the pipeline that contains the stage.",
4401
- "hasDynamicHelp": false,
4402
- "multiple": false,
4403
- "type": "option"
4404
- },
4405
- "stage-id": {
4406
- "name": "stage-id",
4407
- "required": true,
4408
- "summary": "ID of the pipeline stage.",
4563
+ "summary": "ID of the pipeline where the stage is added.",
4409
4564
  "hasDynamicHelp": false,
4410
4565
  "multiple": false,
4411
4566
  "type": "option"
4412
4567
  },
4413
- "environment-name": {
4414
- "char": "e",
4415
- "name": "environment-name",
4568
+ "name": {
4569
+ "char": "n",
4570
+ "name": "name",
4416
4571
  "required": true,
4417
- "summary": "Name of the environment.",
4572
+ "summary": "Name of the pipeline stage, such as Integration, UAT, or Staging.",
4418
4573
  "hasDynamicHelp": false,
4419
4574
  "multiple": false,
4420
4575
  "type": "option"
4421
4576
  },
4422
- "org-type": {
4423
- "name": "org-type",
4577
+ "next-stage-id": {
4578
+ "name": "next-stage-id",
4424
4579
  "required": true,
4425
- "summary": "Type of the Salesforce org. Valid values: Production, Sandbox.",
4580
+ "summary": "ID of the stage that follows the new stage in the pipeline.",
4426
4581
  "hasDynamicHelp": false,
4427
4582
  "multiple": false,
4428
- "options": [
4429
- "Production",
4430
- "Sandbox"
4431
- ],
4432
4583
  "type": "option"
4433
- },
4434
- "no-browser": {
4435
- "name": "no-browser",
4436
- "summary": "Don't auto-open the browser for OAuth authentication. The redirect URL is printed for manual use.",
4437
- "allowNo": false,
4438
- "type": "boolean"
4439
- },
4440
- "force": {
4441
- "name": "force",
4442
- "summary": "Replace the stage's existing environment. By default, the command blocks if the stage already has an environment to avoid orphaning it. With this flag, the new environment is added first and the previous one is removed only after the new environment is associated successfully.",
4443
- "allowNo": false,
4444
- "type": "boolean"
4445
4584
  }
4446
4585
  },
4447
4586
  "hasDynamicHelp": true,
4448
4587
  "hiddenAliases": [],
4449
- "id": "devops:stage:environment:add",
4588
+ "id": "devops:pipeline:stage:add",
4450
4589
  "pluginAlias": "@salesforce/plugin-devops-center",
4451
4590
  "pluginName": "@salesforce/plugin-devops-center",
4452
4591
  "pluginType": "jit",
4453
4592
  "strict": true,
4454
- "summary": "Add a Salesforce environment to a pipeline stage.",
4593
+ "summary": "Add a stage to a DevOps Center pipeline.",
4455
4594
  "enableJsonFlag": true,
4456
4595
  "isESM": true,
4457
4596
  "relativePath": [
4458
4597
  "lib",
4459
4598
  "commands",
4460
4599
  "devops",
4600
+ "pipeline",
4461
4601
  "stage",
4462
- "environment",
4463
4602
  "add.js"
4464
4603
  ]
4465
4604
  },
4466
- "devops:stage:environment:delete": {
4605
+ "devops:pipeline:stage:delete": {
4467
4606
  "aliases": [],
4468
4607
  "args": {},
4469
- "description": "Removes the specified environment from the pipeline stage. The environment must belong to an inactive pipeline.",
4608
+ "description": "Deletes the specified stage from the pipeline. If the stage sits between two other stages, the predecessor stage is automatically re-linked to the successor so the pipeline chain stays intact.",
4470
4609
  "examples": [
4471
- "Delete an environment:\n<%= config.bin %> <%= command.id %> --target-org my-devops-org --pipeline-id 0XB000000000001 --environment-id 0Xe000000000001"
4610
+ "Delete a stage from a pipeline:\n<%= config.bin %> <%= command.id %> --target-org my-devops-org --pipeline-id 0XB000000000001 --stage-id 0Xc000000000002"
4472
4611
  ],
4473
4612
  "flags": {
4474
4613
  "json": {
@@ -4506,16 +4645,15 @@
4506
4645
  "pipeline-id": {
4507
4646
  "name": "pipeline-id",
4508
4647
  "required": true,
4509
- "summary": "ID of the pipeline. Used to verify the pipeline is inactive before deleting.",
4648
+ "summary": "ID of the pipeline that contains the stage.",
4510
4649
  "hasDynamicHelp": false,
4511
4650
  "multiple": false,
4512
4651
  "type": "option"
4513
4652
  },
4514
- "environment-id": {
4515
- "char": "e",
4516
- "name": "environment-id",
4653
+ "stage-id": {
4654
+ "name": "stage-id",
4517
4655
  "required": true,
4518
- "summary": "ID of the environment to delete.",
4656
+ "summary": "ID of the stage to delete.",
4519
4657
  "hasDynamicHelp": false,
4520
4658
  "multiple": false,
4521
4659
  "type": "option"
@@ -4523,30 +4661,29 @@
4523
4661
  },
4524
4662
  "hasDynamicHelp": true,
4525
4663
  "hiddenAliases": [],
4526
- "id": "devops:stage:environment:delete",
4664
+ "id": "devops:pipeline:stage:delete",
4527
4665
  "pluginAlias": "@salesforce/plugin-devops-center",
4528
4666
  "pluginName": "@salesforce/plugin-devops-center",
4529
4667
  "pluginType": "jit",
4530
4668
  "strict": true,
4531
- "summary": "Delete an environment from a DevOps Center pipeline stage.",
4669
+ "summary": "Delete a stage from a DevOps Center pipeline.",
4532
4670
  "enableJsonFlag": true,
4533
4671
  "isESM": true,
4534
4672
  "relativePath": [
4535
4673
  "lib",
4536
4674
  "commands",
4537
4675
  "devops",
4676
+ "pipeline",
4538
4677
  "stage",
4539
- "environment",
4540
4678
  "delete.js"
4541
4679
  ]
4542
4680
  },
4543
- "project:deploy:pipeline:quick": {
4681
+ "devops:pipeline:stage:update": {
4544
4682
  "aliases": [],
4545
4683
  "args": {},
4546
- "description": "The first time you run any \"project deploy pipeline\" command, be sure to authorize the org in which DevOps Center is installed. The easiest way to authorize an org is with the \"org login web\" command.\n\nBefore you run this command, create a validated deployment with the \"project deploy pipeline validate\" command, which returns a job ID. Validated deployments haven't been deployed to the org yet; you deploy them with this command. Either pass the job ID to this command or use the --use-most-recent flag to use the job ID of the most recently validated deployment. For the quick deploy to succeed, the associated validated deployment must also have succeeded.\n\nExecuting this quick deploy command takes less time than a standard deploy because it skips running Apex tests. These tests were previously run as part of the validation. Validating first and then running a quick deploy is useful if the deployment to your production org take several hours and you don’t want to risk a failed deploy.\n\nThis command doesn't support source-tracking. The source you deploy overwrites the corresponding metadata in your org. This command doesn’t attempt to merge your source with the versions in your org.",
4684
+ "description": "Updates the name of a pipeline stage.",
4547
4685
  "examples": [
4548
- "Run a quick deploy using your default Devops Center org and a job ID:\n<%= config.bin %> <%= command.id %> --job-id 0Af0x000017yLUFCA2",
4549
- "Asynchronously run a quick deploy of the most recently validated deployment using an org with alias \"my-prod-org\":\n<%= config.bin %> <%= command.id %> --async --use-most-recent --devops-center-username my-prod-org"
4686
+ "Rename a pipeline stage.\n<%= config.bin %> <%= command.id %> --target-org my-devops-org --stage-id 1QV000000000001 --name \"Integration\""
4550
4687
  ],
4551
4688
  "flags": {
4552
4689
  "json": {
@@ -4564,96 +4701,68 @@
4564
4701
  "multiple": false,
4565
4702
  "type": "option"
4566
4703
  },
4567
- "async": {
4568
- "description": "The command immediately returns the job ID and control of the terminal to you. This way, you can continue to use the CLI. To resume the deployment, run \"sf project deploy pipeline resume\". To check the status of the deployment, run \"sf project deploy pipeline report\".",
4569
- "name": "async",
4570
- "summary": "Run the command asynchronously.",
4571
- "allowNo": false,
4572
- "type": "boolean"
4573
- },
4574
- "concise": {
4575
- "exclusive": [
4576
- "verbose"
4577
- ],
4578
- "name": "concise",
4579
- "summary": "Show concise output of the command result.",
4580
- "allowNo": false,
4581
- "type": "boolean"
4582
- },
4583
- "verbose": {
4584
- "name": "verbose",
4585
- "summary": "Show verbose output of the command result.",
4586
- "allowNo": false,
4587
- "type": "boolean"
4588
- },
4589
- "wait": {
4590
- "char": "w",
4591
- "description": "If the command continues to run after the wait period, the CLI returns control of the terminal window to you and returns the job ID. To check the status of the operation, run \"sf project deploy pipeline report\".",
4592
- "exclusive": [
4593
- "async"
4594
- ],
4595
- "name": "wait",
4596
- "summary": "Number of minutes to wait for command to complete and display results.",
4597
- "default": "33 minutes",
4704
+ "target-org": {
4705
+ "char": "o",
4706
+ "name": "target-org",
4707
+ "noCacheDefault": true,
4708
+ "required": true,
4709
+ "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
4598
4710
  "hasDynamicHelp": true,
4599
- "helpValue": "<minutes>",
4600
4711
  "multiple": false,
4601
4712
  "type": "option"
4602
4713
  },
4603
- "devops-center-username": {
4604
- "char": "c",
4605
- "name": "devops-center-username",
4606
- "required": true,
4607
- "summary": "Username or alias of the DevOps Center org.",
4608
- "hasDynamicHelp": true,
4714
+ "api-version": {
4715
+ "description": "Override the api version used for api requests made by this command",
4716
+ "name": "api-version",
4717
+ "hasDynamicHelp": false,
4609
4718
  "multiple": false,
4610
4719
  "type": "option"
4611
4720
  },
4612
- "job-id": {
4613
- "char": "i",
4614
- "description": "The job ID is valid for 10 days from when you started the validation.",
4615
- "name": "job-id",
4616
- "summary": "Job ID of the validated deployment to quick deploy.",
4721
+ "stage-id": {
4722
+ "char": "s",
4723
+ "name": "stage-id",
4724
+ "required": true,
4725
+ "summary": "ID of the pipeline stage to update.",
4617
4726
  "hasDynamicHelp": false,
4618
4727
  "multiple": false,
4619
4728
  "type": "option"
4620
4729
  },
4621
- "use-most-recent": {
4622
- "char": "r",
4623
- "description": "For performance reasons, this flag uses only job IDs that were validated in the past 3 days or less. If your most recent deployment validation was more than 3 days ago, this flag won't find the job ID.",
4624
- "name": "use-most-recent",
4625
- "summary": "Use the job ID of the most recently validated deployment.",
4626
- "allowNo": false,
4627
- "type": "boolean"
4730
+ "name": {
4731
+ "char": "n",
4732
+ "name": "name",
4733
+ "required": true,
4734
+ "summary": "New name for the pipeline stage.",
4735
+ "hasDynamicHelp": false,
4736
+ "multiple": false,
4737
+ "type": "option"
4628
4738
  }
4629
4739
  },
4630
4740
  "hasDynamicHelp": true,
4631
4741
  "hiddenAliases": [],
4632
- "id": "project:deploy:pipeline:quick",
4742
+ "id": "devops:pipeline:stage:update",
4633
4743
  "pluginAlias": "@salesforce/plugin-devops-center",
4634
4744
  "pluginName": "@salesforce/plugin-devops-center",
4635
4745
  "pluginType": "jit",
4636
- "state": "beta",
4637
4746
  "strict": true,
4638
- "summary": "Quickly deploy a validated deployment to an org.",
4747
+ "summary": "Update a DevOps Center pipeline stage.",
4639
4748
  "enableJsonFlag": true,
4640
4749
  "isESM": true,
4641
4750
  "relativePath": [
4642
4751
  "lib",
4643
4752
  "commands",
4644
- "project",
4645
- "deploy",
4753
+ "devops",
4646
4754
  "pipeline",
4647
- "quick.js"
4755
+ "stage",
4756
+ "update.js"
4648
4757
  ]
4649
4758
  },
4650
- "project:deploy:pipeline:report": {
4759
+ "devops:stage:branch:add": {
4651
4760
  "aliases": [],
4652
4761
  "args": {},
4653
- "description": "The first time you run any \"project deploy pipeline\" command, be sure to authorize the org in which DevOps Center is installed. The easiest way to authorize an org is with the \"org login web\" command.\n\nRun this command by either indicating a job ID or specifying the —use-most-recent flag to use the job ID of the most recent deploy operation.",
4762
+ "description": "By default, the branch must exist in the repository. Use --create-vcs-branch to create a branch if it doesn't exist.\nEach pipeline stage supports only one branch. If the stage already has a branch, the command blocks so the existing branch isn't orphaned; pass --force to replace it.",
4654
4763
  "examples": [
4655
- "Check the status using a job ID:\n<%= config.bin %> <%= command.id %> --devops-center-username MyStagingSandbox --job-id 0Af0x000017yLUFCA2",
4656
- "Check the status of the most recent deploy operation:\n<%= config.bin %> <%= command.id %> --devops-center-username MyStagingSandbox --use-most-recent"
4764
+ "Add an existing branch to a stage:\n<%= config.bin %> <%= command.id %> --target-org my-devops-org --pipeline-id 0Xo000000000001 --stage-id 0Xp000000000001 --branch-name main",
4765
+ "Create and add a branch to a pipeline stage:\n<%= config.bin %> <%= command.id %> --target-org my-devops-org --pipeline-id 0Xo000000000001 --stage-id 0Xp000000000002 --branch-name integration --create-vcs-branch"
4657
4766
  ],
4658
4767
  "flags": {
4659
4768
  "json": {
@@ -4671,60 +4780,86 @@
4671
4780
  "multiple": false,
4672
4781
  "type": "option"
4673
4782
  },
4674
- "devops-center-username": {
4675
- "char": "c",
4676
- "name": "devops-center-username",
4783
+ "target-org": {
4784
+ "char": "o",
4785
+ "name": "target-org",
4786
+ "noCacheDefault": true,
4677
4787
  "required": true,
4678
- "summary": "Username or alias of the DevOps Center org.",
4788
+ "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
4679
4789
  "hasDynamicHelp": true,
4680
4790
  "multiple": false,
4681
4791
  "type": "option"
4682
4792
  },
4683
- "job-id": {
4684
- "char": "i",
4685
- "description": "The job ID is valid for 10 days from when you started the deploy operation.",
4686
- "name": "job-id",
4687
- "summary": "Job ID of the pipeline deployment to check the status of.",
4793
+ "api-version": {
4794
+ "description": "Override the api version used for api requests made by this command",
4795
+ "name": "api-version",
4688
4796
  "hasDynamicHelp": false,
4689
4797
  "multiple": false,
4690
4798
  "type": "option"
4691
4799
  },
4692
- "use-most-recent": {
4693
- "char": "r",
4694
- "description": "For performance reasons, this flag uses job IDs for deploy operations that started in the past 3 days or fewer. If your most recent operation was longer than 3 days ago, this flag won't find the job ID.",
4695
- "name": "use-most-recent",
4696
- "summary": "Use the job ID of the most recent deploy operation.",
4800
+ "pipeline-id": {
4801
+ "name": "pipeline-id",
4802
+ "required": true,
4803
+ "summary": "ID of the pipeline that contains the stage.",
4804
+ "hasDynamicHelp": false,
4805
+ "multiple": false,
4806
+ "type": "option"
4807
+ },
4808
+ "stage-id": {
4809
+ "name": "stage-id",
4810
+ "required": true,
4811
+ "summary": "ID of the pipeline stage to associate the branch with.",
4812
+ "hasDynamicHelp": false,
4813
+ "multiple": false,
4814
+ "type": "option"
4815
+ },
4816
+ "branch-name": {
4817
+ "char": "b",
4818
+ "name": "branch-name",
4819
+ "required": true,
4820
+ "summary": "Name of the repository branch to assign to the stage.",
4821
+ "hasDynamicHelp": false,
4822
+ "multiple": false,
4823
+ "type": "option"
4824
+ },
4825
+ "create-vcs-branch": {
4826
+ "name": "create-vcs-branch",
4827
+ "summary": "Create the branch in the remote repository if it doesn't already exist.",
4828
+ "allowNo": false,
4829
+ "type": "boolean"
4830
+ },
4831
+ "force": {
4832
+ "name": "force",
4833
+ "summary": "Replace the stage's existing branch. By default, the command blocks if the stage already has a branch to avoid orphaning it. With this flag, the new branch is associated and the previous branch record is removed if no other stage references it.",
4697
4834
  "allowNo": false,
4698
4835
  "type": "boolean"
4699
4836
  }
4700
4837
  },
4701
4838
  "hasDynamicHelp": true,
4702
4839
  "hiddenAliases": [],
4703
- "id": "project:deploy:pipeline:report",
4840
+ "id": "devops:stage:branch:add",
4704
4841
  "pluginAlias": "@salesforce/plugin-devops-center",
4705
4842
  "pluginName": "@salesforce/plugin-devops-center",
4706
4843
  "pluginType": "jit",
4707
- "state": "beta",
4708
4844
  "strict": true,
4709
- "summary": "Check the status of a pipeline deploy operation.",
4845
+ "summary": "Add a source code repository branch to a pipeline stage.",
4710
4846
  "enableJsonFlag": true,
4711
4847
  "isESM": true,
4712
4848
  "relativePath": [
4713
4849
  "lib",
4714
4850
  "commands",
4715
- "project",
4716
- "deploy",
4717
- "pipeline",
4718
- "report.js"
4851
+ "devops",
4852
+ "stage",
4853
+ "branch",
4854
+ "add.js"
4719
4855
  ]
4720
4856
  },
4721
- "project:deploy:pipeline:resume": {
4857
+ "devops:stage:branch:delete": {
4722
4858
  "aliases": [],
4723
4859
  "args": {},
4724
- "description": "The first time you run any \"project deploy pipeline\" command, be sure to authorize the org in which DevOps Center is installed. The easiest way to authorize an org is with the \"org login web\" command. \n\nUse this command to resume watching a pipeline deploy operation if the original command times out or you specified the --async flag.\n\nRun this command by either indicating a job ID or specifying the --use-most-recent flag to use the job ID of the most recent deploy operation.",
4860
+ "description": "Removes the branch linked to the specified pipeline stage. Because branches are configured from right to left (a stage can have a branch only after the stage to its right does), removing a branch also removes the branches from all upstream stages (to the left) in the pipeline, keeping it in a valid state. The branch records in the repository are not deleted; only their association with the stages is removed. The stage must belong to an inactive pipeline.",
4725
4861
  "examples": [
4726
- "Resume watching a deploy operation using a job ID:\n<%= config.bin %> <%= command.id %> --job-id 0Af0x000017yLUFCA2",
4727
- "Resume watching the most recent deploy operation:\n<%= config.bin %> <%= command.id %> --use-most-recent"
4862
+ "Delete the branch associated with a pipeline stage:\n<%= config.bin %> <%= command.id %> --target-org my-devops-org --pipeline-id 0Xo000000000001 --stage-id 0Xp000000000001"
4728
4863
  ],
4729
4864
  "flags": {
4730
4865
  "json": {
@@ -4742,89 +4877,65 @@
4742
4877
  "multiple": false,
4743
4878
  "type": "option"
4744
4879
  },
4745
- "devops-center-username": {
4746
- "char": "c",
4747
- "name": "devops-center-username",
4880
+ "target-org": {
4881
+ "char": "o",
4882
+ "name": "target-org",
4883
+ "noCacheDefault": true,
4748
4884
  "required": true,
4749
- "summary": "Username or alias of the DevOps Center org.",
4885
+ "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
4750
4886
  "hasDynamicHelp": true,
4751
4887
  "multiple": false,
4752
4888
  "type": "option"
4753
4889
  },
4754
- "job-id": {
4755
- "char": "i",
4756
- "description": "These commands return a job ID if they time out or you specified the --async flag:\n\n- sf project deploy pipeline start\n- sf project deploy pipeline validate\n- sf project deploy pipeline quick\n\nThe job ID is valid for 10 days from when you started the deploy operation.",
4757
- "name": "job-id",
4758
- "summary": "Job ID of the pipeline deploy operation you want to resume.",
4890
+ "api-version": {
4891
+ "description": "Override the api version used for api requests made by this command",
4892
+ "name": "api-version",
4759
4893
  "hasDynamicHelp": false,
4760
4894
  "multiple": false,
4761
4895
  "type": "option"
4762
4896
  },
4763
- "use-most-recent": {
4764
- "char": "r",
4765
- "description": "For performance reasons, this flag uses job IDs for operations that started in the past 3 days or fewer. If your most recent operation was longer than 3 days ago, this flag won't find a job ID.",
4766
- "name": "use-most-recent",
4767
- "summary": "Use the job ID of the most recent deploy operation.",
4768
- "allowNo": false,
4769
- "type": "boolean"
4770
- },
4771
- "concise": {
4772
- "exclusive": [
4773
- "verbose"
4774
- ],
4775
- "name": "concise",
4776
- "summary": "Show concise output of the command result.",
4777
- "allowNo": false,
4778
- "type": "boolean"
4779
- },
4780
- "verbose": {
4781
- "name": "verbose",
4782
- "summary": "Show verbose output of the command result.",
4783
- "allowNo": false,
4784
- "type": "boolean"
4897
+ "pipeline-id": {
4898
+ "name": "pipeline-id",
4899
+ "required": true,
4900
+ "summary": "ID of the pipeline that contains the stage. Used to verify the pipeline is inactive before deleting.",
4901
+ "hasDynamicHelp": false,
4902
+ "multiple": false,
4903
+ "type": "option"
4785
4904
  },
4786
- "wait": {
4787
- "char": "w",
4788
- "description": "If the command continues to run after the wait period, the CLI returns control of the terminal window to you and returns the job ID. To check the status of the operation, run \"sf project deploy pipeline report\".",
4789
- "exclusive": [
4790
- "async"
4791
- ],
4792
- "name": "wait",
4793
- "summary": "Number of minutes to wait for command to complete and display results.",
4794
- "default": "33 minutes",
4795
- "hasDynamicHelp": true,
4796
- "helpValue": "<minutes>",
4905
+ "stage-id": {
4906
+ "name": "stage-id",
4907
+ "required": true,
4908
+ "summary": "ID of the pipeline stage whose branch you want to delete.",
4909
+ "hasDynamicHelp": false,
4797
4910
  "multiple": false,
4798
4911
  "type": "option"
4799
4912
  }
4800
4913
  },
4801
4914
  "hasDynamicHelp": true,
4802
4915
  "hiddenAliases": [],
4803
- "id": "project:deploy:pipeline:resume",
4916
+ "id": "devops:stage:branch:delete",
4804
4917
  "pluginAlias": "@salesforce/plugin-devops-center",
4805
4918
  "pluginName": "@salesforce/plugin-devops-center",
4806
4919
  "pluginType": "jit",
4807
- "state": "beta",
4808
4920
  "strict": true,
4809
- "summary": "Resume watching a pipeline deploy operation.",
4921
+ "summary": "Delete the source code repository branch associated with a pipeline stage.",
4810
4922
  "enableJsonFlag": true,
4811
4923
  "isESM": true,
4812
4924
  "relativePath": [
4813
4925
  "lib",
4814
4926
  "commands",
4815
- "project",
4816
- "deploy",
4817
- "pipeline",
4818
- "resume.js"
4927
+ "devops",
4928
+ "stage",
4929
+ "branch",
4930
+ "delete.js"
4819
4931
  ]
4820
4932
  },
4821
- "project:deploy:pipeline:start": {
4933
+ "devops:stage:environment:add": {
4822
4934
  "aliases": [],
4823
4935
  "args": {},
4824
- "description": "The first time you run any \"project deploy pipeline\" command, be sure to authorize the org in which DevOps Center is installed. The easiest way to authorize an org is with the \"org login web\" command.\n\nBefore you run this command, changes in the pipeline stage's branch must be merged in the source control repository.",
4936
+ "description": "This command triggers an OAuth flow to authenticate the environment. A browser window opens automatically for you to log in.",
4825
4937
  "examples": [
4826
- "Deploy changes in the Staging branch to the Staging environment (sandbox), if the previous stage is the bundling stage:\n<%= config.bin %> <%= command.id %> --devops-center-project-name “Recruiting App” --branch-name staging --devops-center-username MyStagingSandbox --bundle-version-name 1.0",
4827
- "Deploy all changes in the main branch to the release environment:\n<%= config.bin %> <%= command.id %> --devops-center-project-name “Recruiting App” --branch-name main --devops-center-username MyReleaseOrg --deploy-all"
4938
+ "Add a production environment to a stage using its ID:\n<%= config.bin %> <%= command.id %> --target-org my-devops-org --stage-id 0Xp000000000001 --environment-name Production_Org --org-type Production"
4828
4939
  ],
4829
4940
  "flags": {
4830
4941
  "json": {
@@ -4842,138 +4953,98 @@
4842
4953
  "multiple": false,
4843
4954
  "type": "option"
4844
4955
  },
4845
- "branch-name": {
4846
- "char": "b",
4847
- "name": "branch-name",
4848
- "required": true,
4849
- "summary": "Name of the branch in the source control repository that corresponds to the pipeline stage that you want to deploy the changes to.",
4850
- "hasDynamicHelp": false,
4956
+ "target-org": {
4957
+ "char": "o",
4958
+ "name": "target-org",
4959
+ "noCacheDefault": true,
4960
+ "required": true,
4961
+ "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
4962
+ "hasDynamicHelp": true,
4851
4963
  "multiple": false,
4852
4964
  "type": "option"
4853
4965
  },
4854
- "bundle-version-name": {
4855
- "char": "v",
4856
- "description": "You must indicate the bundle version if deploying to the environment that corresponds to the first stage after the bundling stage.",
4857
- "name": "bundle-version-name",
4858
- "summary": "Version name of the bundle.",
4966
+ "api-version": {
4967
+ "description": "Override the api version used for api requests made by this command",
4968
+ "name": "api-version",
4859
4969
  "hasDynamicHelp": false,
4860
4970
  "multiple": false,
4861
4971
  "type": "option"
4862
4972
  },
4863
- "deploy-all": {
4864
- "char": "a",
4865
- "description": "If you don’t specify this flag, only changes in the stage’s branch are deployed.",
4866
- "name": "deploy-all",
4867
- "summary": "Deploy all metadata in the branch to the stage's org.",
4868
- "allowNo": false,
4869
- "type": "boolean"
4870
- },
4871
- "devops-center-project-name": {
4872
- "char": "p",
4873
- "name": "devops-center-project-name",
4973
+ "pipeline-id": {
4974
+ "name": "pipeline-id",
4874
4975
  "required": true,
4875
- "summary": "Name of the DevOps Center project.",
4976
+ "summary": "ID of the pipeline that contains the stage.",
4876
4977
  "hasDynamicHelp": false,
4877
4978
  "multiple": false,
4878
4979
  "type": "option"
4879
4980
  },
4880
- "devops-center-username": {
4881
- "char": "c",
4882
- "name": "devops-center-username",
4981
+ "stage-id": {
4982
+ "name": "stage-id",
4883
4983
  "required": true,
4884
- "summary": "Username or alias of the DevOps Center org.",
4885
- "hasDynamicHelp": true,
4984
+ "summary": "ID of the pipeline stage.",
4985
+ "hasDynamicHelp": false,
4886
4986
  "multiple": false,
4887
4987
  "type": "option"
4888
4988
  },
4889
- "tests": {
4890
- "char": "t",
4891
- "description": "Separate multiple test names with commas. Enclose the entire flag value in double quotes if a test name contains spaces.",
4892
- "name": "tests",
4893
- "summary": "Apex tests to run when --test-level is RunSpecifiedTests.",
4989
+ "environment-name": {
4990
+ "char": "e",
4991
+ "name": "environment-name",
4992
+ "required": true,
4993
+ "summary": "Name of the environment.",
4894
4994
  "hasDynamicHelp": false,
4895
- "multiple": true,
4995
+ "multiple": false,
4896
4996
  "type": "option"
4897
4997
  },
4898
- "test-level": {
4899
- "char": "l",
4900
- "description": "Valid values are:\n\n- NoTestRun — No tests are run. This test level applies only to deployments to development environments, such as sandbox, Developer Edition, or trial orgs. This test level is the default for development environments.\n\n- RunSpecifiedTests — Runs only the tests that you specify with the --tests flag. Code coverage requirements differ from the default coverage requirements when using this test level. Executed tests must comprise a minimum of 75% code coverage for each class and trigger in the deployment package. This coverage is computed for each class and trigger individually and is different than the overall coverage percentage.\n\n- RunLocalTests — All tests in your org are run, except the ones that originate from installed managed and unlocked packages. This test level is the default for production deployments that include Apex classes or triggers.\n\n- RunAllTestsInOrg — All tests in your org are run, including tests of managed packages.\n\nIf you don’t specify a test level, the default behavior depends on the contents of your deployment package. For more information, see the section \"Running Tests in a Deployment\" in the \"Metadata API Developer Guide\". (https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_deploy_running_tests.htm)",
4901
- "name": "test-level",
4902
- "summary": "Deployment Apex testing level.",
4998
+ "org-type": {
4999
+ "name": "org-type",
5000
+ "required": true,
5001
+ "summary": "Type of the Salesforce org. Valid values: Production, Sandbox.",
4903
5002
  "hasDynamicHelp": false,
4904
5003
  "multiple": false,
4905
5004
  "options": [
4906
- "NoTestRun",
4907
- "RunSpecifiedTests",
4908
- "RunLocalTests",
4909
- "RunAllTestsInOrg"
4910
- ],
4911
- "type": "option"
4912
- },
4913
- "async": {
4914
- "description": "The command immediately returns the job ID and control of the terminal to you. This way, you can continue to use the CLI. To resume the deployment, run \"sf project deploy pipeline resume\". To check the status of the deployment, run \"sf project deploy pipeline report\".",
4915
- "name": "async",
4916
- "summary": "Run the command asynchronously.",
4917
- "allowNo": false,
4918
- "type": "boolean"
4919
- },
4920
- "wait": {
4921
- "char": "w",
4922
- "description": "If the command continues to run after the wait period, the CLI returns control of the terminal window to you and returns the job ID. To check the status of the operation, run \"sf project deploy pipeline report\".",
4923
- "exclusive": [
4924
- "async"
5005
+ "Production",
5006
+ "Sandbox"
4925
5007
  ],
4926
- "name": "wait",
4927
- "summary": "Number of minutes to wait for command to complete and display results.",
4928
- "default": "33 minutes",
4929
- "hasDynamicHelp": true,
4930
- "helpValue": "<minutes>",
4931
- "multiple": false,
4932
5008
  "type": "option"
4933
5009
  },
4934
- "verbose": {
4935
- "name": "verbose",
4936
- "summary": "Show verbose output of the command result.",
5010
+ "no-browser": {
5011
+ "name": "no-browser",
5012
+ "summary": "Don't auto-open the browser for OAuth authentication. The redirect URL is printed for manual use.",
4937
5013
  "allowNo": false,
4938
5014
  "type": "boolean"
4939
5015
  },
4940
- "concise": {
4941
- "exclusive": [
4942
- "verbose"
4943
- ],
4944
- "name": "concise",
4945
- "summary": "Show concise output of the command result.",
5016
+ "force": {
5017
+ "name": "force",
5018
+ "summary": "Replace the stage's existing environment. By default, the command blocks if the stage already has an environment to avoid orphaning it. With this flag, the new environment is added first and the previous one is removed only after the new environment is associated successfully.",
4946
5019
  "allowNo": false,
4947
5020
  "type": "boolean"
4948
5021
  }
4949
5022
  },
4950
5023
  "hasDynamicHelp": true,
4951
5024
  "hiddenAliases": [],
4952
- "id": "project:deploy:pipeline:start",
5025
+ "id": "devops:stage:environment:add",
4953
5026
  "pluginAlias": "@salesforce/plugin-devops-center",
4954
5027
  "pluginName": "@salesforce/plugin-devops-center",
4955
5028
  "pluginType": "jit",
4956
- "state": "beta",
4957
5029
  "strict": true,
4958
- "summary": "Deploy changes from a branch to the pipeline stage’s org.",
5030
+ "summary": "Add a Salesforce environment to a pipeline stage.",
4959
5031
  "enableJsonFlag": true,
4960
5032
  "isESM": true,
4961
5033
  "relativePath": [
4962
5034
  "lib",
4963
5035
  "commands",
4964
- "project",
4965
- "deploy",
4966
- "pipeline",
4967
- "start.js"
5036
+ "devops",
5037
+ "stage",
5038
+ "environment",
5039
+ "add.js"
4968
5040
  ]
4969
5041
  },
4970
- "project:deploy:pipeline:validate": {
5042
+ "devops:stage:environment:delete": {
4971
5043
  "aliases": [],
4972
5044
  "args": {},
4973
- "description": "The first time you run any \"project deploy pipeline\" command, be sure to authorize the org in which DevOps Center is installed. The easiest way to authorize an org is with the \"org login web\" command.\n\nA validation runs Apex tests to verify whether a deployment will succeed without actually deploying the metadata to your environment, so you can then quickly deploy the changes later without re-running the tests.",
5045
+ "description": "Removes the specified environment from the pipeline stage. The environment must belong to an inactive pipeline.",
4974
5046
  "examples": [
4975
- "Perform a validate-only deployment from the Staging branch to the Staging environment (sandbox):\n<%= config.bin %> <%= command.id %> --devops-center-project-name “Recruiting App” --branch-name staging --devops-center-username MyStagingSandbox",
4976
- "Perform a validate-only deployment of all changes from the main branch to the release environment:\n<%= config.bin %> <%= command.id %> --devops-center-project-name “Recruiting App” --branch-name main --devops-center-username MyReleaseOrg --deploy-all"
5047
+ "Delete an environment:\n<%= config.bin %> <%= command.id %> --target-org my-devops-org --pipeline-id 0XB000000000001 --environment-id 0Xe000000000001"
4977
5048
  ],
4978
5049
  "flags": {
4979
5050
  "json": {
@@ -4991,129 +5062,58 @@
4991
5062
  "multiple": false,
4992
5063
  "type": "option"
4993
5064
  },
4994
- "branch-name": {
4995
- "char": "b",
4996
- "name": "branch-name",
5065
+ "target-org": {
5066
+ "char": "o",
5067
+ "name": "target-org",
5068
+ "noCacheDefault": true,
4997
5069
  "required": true,
4998
- "summary": "Name of the branch in the source control repository that corresponds to the pipeline stage that you want to deploy the changes to.",
4999
- "hasDynamicHelp": false,
5070
+ "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
5071
+ "hasDynamicHelp": true,
5000
5072
  "multiple": false,
5001
5073
  "type": "option"
5002
5074
  },
5003
- "bundle-version-name": {
5004
- "char": "v",
5005
- "description": "You must indicate the bundle version if deploying to the environment that corresponds to the first stage after the bundling stage.",
5006
- "name": "bundle-version-name",
5007
- "summary": "Version name of the bundle.",
5075
+ "api-version": {
5076
+ "description": "Override the api version used for api requests made by this command",
5077
+ "name": "api-version",
5008
5078
  "hasDynamicHelp": false,
5009
5079
  "multiple": false,
5010
5080
  "type": "option"
5011
5081
  },
5012
- "deploy-all": {
5013
- "char": "a",
5014
- "description": "If you don’t specify this flag, only changes in the stage’s branch are deployed.",
5015
- "name": "deploy-all",
5016
- "summary": "Deploy all metadata in the branch to the stage's org.",
5017
- "allowNo": false,
5018
- "type": "boolean"
5019
- },
5020
- "devops-center-project-name": {
5021
- "char": "p",
5022
- "name": "devops-center-project-name",
5082
+ "pipeline-id": {
5083
+ "name": "pipeline-id",
5023
5084
  "required": true,
5024
- "summary": "Name of the DevOps Center project.",
5085
+ "summary": "ID of the pipeline. Used to verify the pipeline is inactive before deleting.",
5025
5086
  "hasDynamicHelp": false,
5026
5087
  "multiple": false,
5027
5088
  "type": "option"
5028
5089
  },
5029
- "devops-center-username": {
5030
- "char": "c",
5031
- "name": "devops-center-username",
5090
+ "environment-id": {
5091
+ "char": "e",
5092
+ "name": "environment-id",
5032
5093
  "required": true,
5033
- "summary": "Username or alias of the DevOps Center org.",
5034
- "hasDynamicHelp": true,
5035
- "multiple": false,
5036
- "type": "option"
5037
- },
5038
- "tests": {
5039
- "char": "t",
5040
- "description": "Separate multiple test names with commas. Enclose the entire flag value in double quotes if a test name contains spaces.",
5041
- "name": "tests",
5042
- "summary": "Apex tests to run when --test-level is RunSpecifiedTests.",
5043
- "hasDynamicHelp": false,
5044
- "multiple": true,
5045
- "type": "option"
5046
- },
5047
- "test-level": {
5048
- "char": "l",
5049
- "description": "Valid values are:\n\n- NoTestRun — No tests are run. This test level applies only to deployments to development environments, such as sandbox, Developer Edition, or trial orgs. This test level is the default for development environments.\n\n- RunSpecifiedTests — Runs only the tests that you specify with the --tests flag. Code coverage requirements differ from the default coverage requirements when using this test level. Executed tests must comprise a minimum of 75% code coverage for each class and trigger in the deployment package. This coverage is computed for each class and trigger individually and is different than the overall coverage percentage.\n\n- RunLocalTests — All tests in your org are run, except the ones that originate from installed managed and unlocked packages. This test level is the default for production deployments that include Apex classes or triggers.\n\n- RunAllTestsInOrg — All tests in your org are run, including tests of managed packages.\n\nIf you don’t specify a test level, the default behavior depends on the contents of your deployment package. For more information, see the section \"Running Tests in a Deployment\" in the \"Metadata API Developer Guide\". (https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_deploy_running_tests.htm)",
5050
- "name": "test-level",
5051
- "summary": "Deployment Apex testing level.",
5094
+ "summary": "ID of the environment to delete.",
5052
5095
  "hasDynamicHelp": false,
5053
5096
  "multiple": false,
5054
- "options": [
5055
- "NoTestRun",
5056
- "RunSpecifiedTests",
5057
- "RunLocalTests",
5058
- "RunAllTestsInOrg"
5059
- ],
5060
- "type": "option"
5061
- },
5062
- "async": {
5063
- "description": "The command immediately returns the job ID and control of the terminal to you. This way, you can continue to use the CLI. To resume the deployment, run \"sf project deploy pipeline resume\". To check the status of the deployment, run \"sf project deploy pipeline report\".",
5064
- "name": "async",
5065
- "summary": "Run the command asynchronously.",
5066
- "allowNo": false,
5067
- "type": "boolean"
5068
- },
5069
- "wait": {
5070
- "char": "w",
5071
- "description": "If the command continues to run after the wait period, the CLI returns control of the terminal window to you and returns the job ID. To check the status of the operation, run \"sf project deploy pipeline report\".",
5072
- "exclusive": [
5073
- "async"
5074
- ],
5075
- "name": "wait",
5076
- "summary": "Number of minutes to wait for command to complete and display results.",
5077
- "default": "33 minutes",
5078
- "hasDynamicHelp": true,
5079
- "helpValue": "<minutes>",
5080
- "multiple": false,
5081
5097
  "type": "option"
5082
- },
5083
- "verbose": {
5084
- "name": "verbose",
5085
- "summary": "Show verbose output of the command result.",
5086
- "allowNo": false,
5087
- "type": "boolean"
5088
- },
5089
- "concise": {
5090
- "exclusive": [
5091
- "verbose"
5092
- ],
5093
- "name": "concise",
5094
- "summary": "Show concise output of the command result.",
5095
- "allowNo": false,
5096
- "type": "boolean"
5097
5098
  }
5098
5099
  },
5099
5100
  "hasDynamicHelp": true,
5100
5101
  "hiddenAliases": [],
5101
- "id": "project:deploy:pipeline:validate",
5102
+ "id": "devops:stage:environment:delete",
5102
5103
  "pluginAlias": "@salesforce/plugin-devops-center",
5103
5104
  "pluginName": "@salesforce/plugin-devops-center",
5104
5105
  "pluginType": "jit",
5105
- "state": "beta",
5106
5106
  "strict": true,
5107
- "summary": "Perform a validate-only deployment from a branch to the pipeline stage’s org.",
5107
+ "summary": "Delete an environment from a DevOps Center pipeline stage.",
5108
5108
  "enableJsonFlag": true,
5109
5109
  "isESM": true,
5110
5110
  "relativePath": [
5111
5111
  "lib",
5112
5112
  "commands",
5113
- "project",
5114
- "deploy",
5115
- "pipeline",
5116
- "validate.js"
5113
+ "devops",
5114
+ "stage",
5115
+ "environment",
5116
+ "delete.js"
5117
5117
  ]
5118
5118
  },
5119
5119
  "flow:get:log": {
@@ -5758,15 +5758,16 @@
5758
5758
  "site:dev:lightning"
5759
5759
  ]
5760
5760
  },
5761
- "org:create:shape": {
5761
+ "org:get:snapshot": {
5762
5762
  "aliases": [
5763
- "force:org:shape:create"
5763
+ "force:org:snapshot:get"
5764
5764
  ],
5765
5765
  "args": {},
5766
5766
  "deprecateAliases": true,
5767
- "description": "Scratch org shapes mimic the baseline setup (features, limits, edition, and Metadata API settings) of a source org without the extraneous data and metadata.\n\nRun \"<%= config.bin %> org list shape\" to view the available org shapes and their IDs.\n\nTo create a scratch org from an org shape, include the \"sourceOrg\" property in the scratch org definition file and set it to the org ID of the source org. Then create a scratch org with the \"<%= config.bin %> org create scratch\" command.",
5767
+ "description": "Snapshot creation can take a while. Use this command with the snapshot name or ID to check its creation status. After the status changes to Active, you can use the snapshot to create scratch orgs.\n\nTo create a snapshot, use the \"<%= config.bin %> org create snapshot\" command. To retrieve a list of all snapshots, use \"<%= config.bin %> org list snapshot\".",
5768
5768
  "examples": [
5769
- "Create an org shape for the source org with alias SourceOrg:\n<%= config.bin %> <%= command.id %> --target-org SourceOrg"
5769
+ "Get snapshot details using its ID and the default Dev Hub org:\n<%= config.bin %> <%= command.id %> --snapshot 0Oo...",
5770
+ "Get snapshot details using its name from a Dev Hub org with alias SnapshotDevHub:\n<%= config.bin %> <%= command.id %> --snapshot Dependencies --target-dev-hub SnapshotDevHub"
5770
5771
  ],
5771
5772
  "flags": {
5772
5773
  "json": {
@@ -5784,17 +5785,16 @@
5784
5785
  "multiple": false,
5785
5786
  "type": "option"
5786
5787
  },
5787
- "target-org": {
5788
+ "target-dev-hub": {
5788
5789
  "aliases": [
5789
- "targetusername",
5790
- "u"
5790
+ "targetdevhubusername"
5791
5791
  ],
5792
- "char": "o",
5792
+ "char": "v",
5793
5793
  "deprecateAliases": true,
5794
- "name": "target-org",
5794
+ "name": "target-dev-hub",
5795
5795
  "noCacheDefault": true,
5796
5796
  "required": true,
5797
- "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
5797
+ "summary": "Username or alias of the Dev Hub org. Not required if the `target-dev-hub` configuration variable is already set.",
5798
5798
  "hasDynamicHelp": true,
5799
5799
  "multiple": false,
5800
5800
  "type": "option"
@@ -5819,70 +5819,80 @@
5819
5819
  "hasDynamicHelp": false,
5820
5820
  "multiple": false,
5821
5821
  "type": "option"
5822
+ },
5823
+ "snapshot": {
5824
+ "char": "s",
5825
+ "description": "The IDs of scratch org snapshots start with 0Oo.",
5826
+ "name": "snapshot",
5827
+ "required": true,
5828
+ "summary": "Name or ID of snapshot to retrieve.",
5829
+ "hasDynamicHelp": false,
5830
+ "multiple": false,
5831
+ "type": "option"
5822
5832
  }
5823
5833
  },
5824
5834
  "hasDynamicHelp": true,
5825
5835
  "hiddenAliases": [],
5826
- "id": "org:create:shape",
5836
+ "id": "org:get:snapshot",
5827
5837
  "pluginAlias": "@salesforce/plugin-signups",
5828
5838
  "pluginName": "@salesforce/plugin-signups",
5829
5839
  "pluginType": "jit",
5830
5840
  "strict": true,
5831
- "summary": "Create a scratch org configuration (shape) based on the specified source org.",
5841
+ "summary": "Get details about a scratch org snapshot.",
5832
5842
  "enableJsonFlag": true,
5833
5843
  "isESM": true,
5834
5844
  "relativePath": [
5835
5845
  "lib",
5836
5846
  "commands",
5837
5847
  "org",
5838
- "create",
5839
- "shape.js"
5848
+ "get",
5849
+ "snapshot.js"
5840
5850
  ],
5841
5851
  "aliasPermutations": [
5842
- "force:org:shape:create",
5843
- "org:force:shape:create",
5844
- "org:shape:force:create",
5845
- "org:shape:create:force",
5846
- "force:shape:org:create",
5847
- "shape:force:org:create",
5848
- "shape:org:force:create",
5849
- "shape:org:create:force",
5850
- "force:shape:create:org",
5851
- "shape:force:create:org",
5852
- "shape:create:force:org",
5853
- "shape:create:org:force",
5854
- "force:org:create:shape",
5855
- "org:force:create:shape",
5856
- "org:create:force:shape",
5857
- "org:create:shape:force",
5858
- "force:create:org:shape",
5859
- "create:force:org:shape",
5860
- "create:org:force:shape",
5861
- "create:org:shape:force",
5862
- "force:create:shape:org",
5863
- "create:force:shape:org",
5864
- "create:shape:force:org",
5865
- "create:shape:org:force"
5852
+ "force:org:snapshot:get",
5853
+ "org:force:snapshot:get",
5854
+ "org:snapshot:force:get",
5855
+ "org:snapshot:get:force",
5856
+ "force:snapshot:org:get",
5857
+ "snapshot:force:org:get",
5858
+ "snapshot:org:force:get",
5859
+ "snapshot:org:get:force",
5860
+ "force:snapshot:get:org",
5861
+ "snapshot:force:get:org",
5862
+ "snapshot:get:force:org",
5863
+ "snapshot:get:org:force",
5864
+ "force:org:get:snapshot",
5865
+ "org:force:get:snapshot",
5866
+ "org:get:force:snapshot",
5867
+ "org:get:snapshot:force",
5868
+ "force:get:org:snapshot",
5869
+ "get:force:org:snapshot",
5870
+ "get:org:force:snapshot",
5871
+ "get:org:snapshot:force",
5872
+ "force:get:snapshot:org",
5873
+ "get:force:snapshot:org",
5874
+ "get:snapshot:force:org",
5875
+ "get:snapshot:org:force"
5866
5876
  ],
5867
5877
  "permutations": [
5868
- "org:create:shape",
5869
- "create:org:shape",
5870
- "create:shape:org",
5871
- "org:shape:create",
5872
- "shape:org:create",
5873
- "shape:create:org"
5878
+ "org:get:snapshot",
5879
+ "get:org:snapshot",
5880
+ "get:snapshot:org",
5881
+ "org:snapshot:get",
5882
+ "snapshot:org:get",
5883
+ "snapshot:get:org"
5874
5884
  ]
5875
5885
  },
5876
- "org:create:snapshot": {
5886
+ "org:list:shape": {
5877
5887
  "aliases": [
5878
- "force:org:snapshot:create"
5888
+ "force:org:shape:list"
5879
5889
  ],
5880
5890
  "args": {},
5881
5891
  "deprecateAliases": true,
5882
- "description": "A snapshot is a point-in-time copy of a scratch org. The copy is referenced by its unique name in a scratch org definition file.\n\nUse \"<%= config.bin %> org get snapshot\" to get details, including status, about a snapshot creation request.\n\nTo create a scratch org from a snapshot, include the \"snapshot\" option (instead of \"edition\") in the scratch org definition file and set it to the name of the snapshot. Then use \"<%= config.bin %> org create scratch\" to create the scratch org.",
5892
+ "description": "The output includes the alias, username, and ID of the source org, the status of the org shape creation, and more. Use the org ID to update your scratch org configuration file so you can create a scratch org based on this org shape.",
5883
5893
  "examples": [
5884
- "Create a snapshot called \"Dependencies\" using the source scratch org ID and your default Dev Hub org:\n<%= config.bin %> <%= command.id %> --source-org 00Dxx0000000000 --name Dependencies --description 'Contains PackageA v1.1.0'",
5885
- "Create a snapshot called \"NightlyBranch\" using the source scratch org username and a Dev Hub org with alias NightlyDevHub:\n<%= config.bin %> <%= command.id %> --source-org myuser@myorg --name NightlyBranch --description 'Contains PkgA v2.1.0 and PkgB 3.3.0' --target-dev-hub NightlyDevHub"
5894
+ "List all org shapes you've created:\n<%= config.bin %> <%= command.id %>",
5895
+ "List all org shapes in JSON format and write the output to a file:\n<%= config.bin %> <%= command.id %> --json > tmp/MyOrgShapeList.json"
5886
5896
  ],
5887
5897
  "flags": {
5888
5898
  "json": {
@@ -5900,30 +5910,12 @@
5900
5910
  "multiple": false,
5901
5911
  "type": "option"
5902
5912
  },
5903
- "target-dev-hub": {
5904
- "aliases": [
5905
- "targetdevhubusername"
5906
- ],
5907
- "char": "v",
5908
- "deprecateAliases": true,
5909
- "name": "target-dev-hub",
5910
- "noCacheDefault": true,
5911
- "required": true,
5912
- "summary": "Username or alias of the Dev Hub org. Not required if the `target-dev-hub` configuration variable is already set.",
5913
- "hasDynamicHelp": true,
5914
- "multiple": false,
5915
- "type": "option"
5916
- },
5917
- "api-version": {
5918
- "aliases": [
5919
- "apiversion"
5920
- ],
5921
- "deprecateAliases": true,
5922
- "description": "Override the api version used for api requests made by this command",
5923
- "name": "api-version",
5924
- "hasDynamicHelp": false,
5925
- "multiple": false,
5926
- "type": "option"
5913
+ "verbose": {
5914
+ "hidden": true,
5915
+ "name": "verbose",
5916
+ "summary": "List more information about each org shape.",
5917
+ "allowNo": false,
5918
+ "type": "boolean"
5927
5919
  },
5928
5920
  "loglevel": {
5929
5921
  "deprecated": {
@@ -5934,105 +5926,70 @@
5934
5926
  "hasDynamicHelp": false,
5935
5927
  "multiple": false,
5936
5928
  "type": "option"
5937
- },
5938
- "source-org": {
5939
- "aliases": [
5940
- "sourceorg"
5941
- ],
5942
- "char": "o",
5943
- "deprecateAliases": true,
5944
- "name": "source-org",
5945
- "required": true,
5946
- "summary": "ID or locally authenticated username or alias of scratch org to snapshot.",
5947
- "hasDynamicHelp": false,
5948
- "multiple": false,
5949
- "type": "option"
5950
- },
5951
- "name": {
5952
- "aliases": [
5953
- "snapshotname"
5954
- ],
5955
- "char": "n",
5956
- "deprecateAliases": true,
5957
- "name": "name",
5958
- "required": true,
5959
- "summary": "Unique name of snapshot.",
5960
- "hasDynamicHelp": false,
5961
- "multiple": false,
5962
- "type": "option"
5963
- },
5964
- "description": {
5965
- "char": "d",
5966
- "description": "Use this description to document the contents of the snapshot. We suggest that you include a reference point, such as a version control system tag or commit ID.",
5967
- "name": "description",
5968
- "summary": "Description of snapshot.",
5969
- "hasDynamicHelp": false,
5970
- "multiple": false,
5971
- "type": "option"
5972
5929
  }
5973
5930
  },
5974
- "hasDynamicHelp": true,
5931
+ "hasDynamicHelp": false,
5975
5932
  "hiddenAliases": [],
5976
- "id": "org:create:snapshot",
5933
+ "id": "org:list:shape",
5977
5934
  "pluginAlias": "@salesforce/plugin-signups",
5978
5935
  "pluginName": "@salesforce/plugin-signups",
5979
5936
  "pluginType": "jit",
5980
5937
  "strict": true,
5981
- "summary": "Create a snapshot of a scratch org.",
5938
+ "summary": "List all org shapes you’ve created.",
5982
5939
  "enableJsonFlag": true,
5983
5940
  "isESM": true,
5984
5941
  "relativePath": [
5985
5942
  "lib",
5986
5943
  "commands",
5987
5944
  "org",
5988
- "create",
5989
- "snapshot.js"
5945
+ "list",
5946
+ "shape.js"
5990
5947
  ],
5991
5948
  "aliasPermutations": [
5992
- "force:org:snapshot:create",
5993
- "org:force:snapshot:create",
5994
- "org:snapshot:force:create",
5995
- "org:snapshot:create:force",
5996
- "force:snapshot:org:create",
5997
- "snapshot:force:org:create",
5998
- "snapshot:org:force:create",
5999
- "snapshot:org:create:force",
6000
- "force:snapshot:create:org",
6001
- "snapshot:force:create:org",
6002
- "snapshot:create:force:org",
6003
- "snapshot:create:org:force",
6004
- "force:org:create:snapshot",
6005
- "org:force:create:snapshot",
6006
- "org:create:force:snapshot",
6007
- "org:create:snapshot:force",
6008
- "force:create:org:snapshot",
6009
- "create:force:org:snapshot",
6010
- "create:org:force:snapshot",
6011
- "create:org:snapshot:force",
6012
- "force:create:snapshot:org",
6013
- "create:force:snapshot:org",
6014
- "create:snapshot:force:org",
6015
- "create:snapshot:org:force"
5949
+ "force:org:shape:list",
5950
+ "org:force:shape:list",
5951
+ "org:shape:force:list",
5952
+ "org:shape:list:force",
5953
+ "force:shape:org:list",
5954
+ "shape:force:org:list",
5955
+ "shape:org:force:list",
5956
+ "shape:org:list:force",
5957
+ "force:shape:list:org",
5958
+ "shape:force:list:org",
5959
+ "shape:list:force:org",
5960
+ "shape:list:org:force",
5961
+ "force:org:list:shape",
5962
+ "org:force:list:shape",
5963
+ "org:list:force:shape",
5964
+ "org:list:shape:force",
5965
+ "force:list:org:shape",
5966
+ "list:force:org:shape",
5967
+ "list:org:force:shape",
5968
+ "list:org:shape:force",
5969
+ "force:list:shape:org",
5970
+ "list:force:shape:org",
5971
+ "list:shape:force:org",
5972
+ "list:shape:org:force"
6016
5973
  ],
6017
5974
  "permutations": [
6018
- "org:create:snapshot",
6019
- "create:org:snapshot",
6020
- "create:snapshot:org",
6021
- "org:snapshot:create",
6022
- "snapshot:org:create",
6023
- "snapshot:create:org"
5975
+ "org:list:shape",
5976
+ "list:org:shape",
5977
+ "list:shape:org",
5978
+ "org:shape:list",
5979
+ "shape:org:list",
5980
+ "shape:list:org"
6024
5981
  ]
6025
5982
  },
6026
- "org:delete:shape": {
5983
+ "org:list:snapshot": {
6027
5984
  "aliases": [
6028
- "force:org:shape:delete"
5985
+ "force:org:snapshot:list"
6029
5986
  ],
6030
5987
  "args": {},
6031
5988
  "deprecateAliases": true,
6032
- "description": "A source org can have only one active org shape. If you try to create an org shape for a source org that already has one, the previous shape is marked inactive and replaced by a new active shape. If you don’t want to create scratch orgs based on this shape, you can delete the org shape.",
5989
+ "description": "You can view all the snapshots in a Dev Hub that you have access to. If you’re an admin, you can see all snapshots associated with the Dev Hub org. If you’re a user, you can see only your snapshots unless a Dev Hub admin gives you View All permissions.\n\nTo create a snapshot, use the \"<%= config.bin %> org create snapshot\" command. To get details about a snapshot request, use \"<%= config.bin %> org get snapshot\".",
6033
5990
  "examples": [
6034
- "Delete all org shapes for the source org with alias SourceOrg:\n<%= config.bin %> <%= command.id %> --target-org SourceOrg",
6035
- "Delete all org shapes without prompting:\n<%= config.bin %> <%= command.id %> --target-org SourceOrg --no-prompt"
5991
+ "List snapshots in the default Dev Hub:\n<%= config.bin %> <%= command.id %>",
5992
+ "List snapshots in the Dev Hub with alias SnapshotDevHub:\n<%= config.bin %> <%= command.id %> --target-dev-hub SnapshotDevHub"
6036
5993
  ],
6037
5994
  "flags": {
6038
5995
  "json": {
@@ -6050,17 +6007,16 @@
6050
6007
  "multiple": false,
6051
6008
  "type": "option"
6052
6009
  },
6053
- "target-org": {
6010
+ "target-dev-hub": {
6054
6011
  "aliases": [
6055
- "targetusername",
6056
- "u"
6012
+ "targetdevhubusername"
6057
6013
  ],
6058
- "char": "o",
6014
+ "char": "v",
6059
6015
  "deprecateAliases": true,
6060
- "name": "target-org",
6016
+ "name": "target-dev-hub",
6061
6017
  "noCacheDefault": true,
6062
6018
  "required": true,
6063
- "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
6019
+ "summary": "Username or alias of the Dev Hub org. Not required if the `target-dev-hub` configuration variable is already set.",
6064
6020
  "hasDynamicHelp": true,
6065
6021
  "multiple": false,
6066
6022
  "type": "option"
@@ -6085,16 +6041,132 @@
6085
6041
  "hasDynamicHelp": false,
6086
6042
  "multiple": false,
6087
6043
  "type": "option"
6088
- },
6089
- "no-prompt": {
6090
- "aliases": [
6091
- "noprompt"
6092
- ],
6093
- "char": "p",
6094
- "deprecateAliases": true,
6095
- "name": "no-prompt",
6096
- "summary": "Don't prompt for confirmation.",
6097
- "allowNo": false,
6044
+ }
6045
+ },
6046
+ "hasDynamicHelp": true,
6047
+ "hiddenAliases": [],
6048
+ "id": "org:list:snapshot",
6049
+ "pluginAlias": "@salesforce/plugin-signups",
6050
+ "pluginName": "@salesforce/plugin-signups",
6051
+ "pluginType": "jit",
6052
+ "strict": true,
6053
+ "summary": "List scratch org snapshots.",
6054
+ "enableJsonFlag": true,
6055
+ "isESM": true,
6056
+ "relativePath": [
6057
+ "lib",
6058
+ "commands",
6059
+ "org",
6060
+ "list",
6061
+ "snapshot.js"
6062
+ ],
6063
+ "aliasPermutations": [
6064
+ "force:org:snapshot:list",
6065
+ "org:force:snapshot:list",
6066
+ "org:snapshot:force:list",
6067
+ "org:snapshot:list:force",
6068
+ "force:snapshot:org:list",
6069
+ "snapshot:force:org:list",
6070
+ "snapshot:org:force:list",
6071
+ "snapshot:org:list:force",
6072
+ "force:snapshot:list:org",
6073
+ "snapshot:force:list:org",
6074
+ "snapshot:list:force:org",
6075
+ "snapshot:list:org:force",
6076
+ "force:org:list:snapshot",
6077
+ "org:force:list:snapshot",
6078
+ "org:list:force:snapshot",
6079
+ "org:list:snapshot:force",
6080
+ "force:list:org:snapshot",
6081
+ "list:force:org:snapshot",
6082
+ "list:org:force:snapshot",
6083
+ "list:org:snapshot:force",
6084
+ "force:list:snapshot:org",
6085
+ "list:force:snapshot:org",
6086
+ "list:snapshot:force:org",
6087
+ "list:snapshot:org:force"
6088
+ ],
6089
+ "permutations": [
6090
+ "org:list:snapshot",
6091
+ "list:org:snapshot",
6092
+ "list:snapshot:org",
6093
+ "org:snapshot:list",
6094
+ "snapshot:org:list",
6095
+ "snapshot:list:org"
6096
+ ]
6097
+ },
6098
+ "org:delete:shape": {
6099
+ "aliases": [
6100
+ "force:org:shape:delete"
6101
+ ],
6102
+ "args": {},
6103
+ "deprecateAliases": true,
6104
+ "description": "A source org can have only one active org shape. If you try to create an org shape for a source org that already has one, the previous shape is marked inactive and replaced by a new active shape. If you don’t want to create scratch orgs based on this shape, you can delete the org shape.",
6105
+ "examples": [
6106
+ "Delete all org shapes for the source org with alias SourceOrg:\n<%= config.bin %> <%= command.id %> --target-org SourceOrg",
6107
+ "Delete all org shapes without prompting:\n<%= config.bin %> <%= command.id %> --target-org SourceOrg --no-prompt"
6108
+ ],
6109
+ "flags": {
6110
+ "json": {
6111
+ "description": "Format output as json.",
6112
+ "helpGroup": "GLOBAL",
6113
+ "name": "json",
6114
+ "allowNo": false,
6115
+ "type": "boolean"
6116
+ },
6117
+ "flags-dir": {
6118
+ "helpGroup": "GLOBAL",
6119
+ "name": "flags-dir",
6120
+ "summary": "Import flag values from a directory.",
6121
+ "hasDynamicHelp": false,
6122
+ "multiple": false,
6123
+ "type": "option"
6124
+ },
6125
+ "target-org": {
6126
+ "aliases": [
6127
+ "targetusername",
6128
+ "u"
6129
+ ],
6130
+ "char": "o",
6131
+ "deprecateAliases": true,
6132
+ "name": "target-org",
6133
+ "noCacheDefault": true,
6134
+ "required": true,
6135
+ "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
6136
+ "hasDynamicHelp": true,
6137
+ "multiple": false,
6138
+ "type": "option"
6139
+ },
6140
+ "api-version": {
6141
+ "aliases": [
6142
+ "apiversion"
6143
+ ],
6144
+ "deprecateAliases": true,
6145
+ "description": "Override the api version used for api requests made by this command",
6146
+ "name": "api-version",
6147
+ "hasDynamicHelp": false,
6148
+ "multiple": false,
6149
+ "type": "option"
6150
+ },
6151
+ "loglevel": {
6152
+ "deprecated": {
6153
+ "message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SF_LOG_LEVEL` environment variable."
6154
+ },
6155
+ "hidden": true,
6156
+ "name": "loglevel",
6157
+ "hasDynamicHelp": false,
6158
+ "multiple": false,
6159
+ "type": "option"
6160
+ },
6161
+ "no-prompt": {
6162
+ "aliases": [
6163
+ "noprompt"
6164
+ ],
6165
+ "char": "p",
6166
+ "deprecateAliases": true,
6167
+ "name": "no-prompt",
6168
+ "summary": "Don't prompt for confirmation.",
6169
+ "allowNo": false,
6098
6170
  "type": "boolean"
6099
6171
  }
6100
6172
  },
@@ -6282,16 +6354,15 @@
6282
6354
  "snapshot:delete:org"
6283
6355
  ]
6284
6356
  },
6285
- "org:get:snapshot": {
6357
+ "org:create:shape": {
6286
6358
  "aliases": [
6287
- "force:org:snapshot:get"
6359
+ "force:org:shape:create"
6288
6360
  ],
6289
6361
  "args": {},
6290
6362
  "deprecateAliases": true,
6291
- "description": "Snapshot creation can take a while. Use this command with the snapshot name or ID to check its creation status. After the status changes to Active, you can use the snapshot to create scratch orgs.\n\nTo create a snapshot, use the \"<%= config.bin %> org create snapshot\" command. To retrieve a list of all snapshots, use \"<%= config.bin %> org list snapshot\".",
6363
+ "description": "Scratch org shapes mimic the baseline setup (features, limits, edition, and Metadata API settings) of a source org without the extraneous data and metadata.\n\nRun \"<%= config.bin %> org list shape\" to view the available org shapes and their IDs.\n\nTo create a scratch org from an org shape, include the \"sourceOrg\" property in the scratch org definition file and set it to the org ID of the source org. Then create a scratch org with the \"<%= config.bin %> org create scratch\" command.",
6292
6364
  "examples": [
6293
- "Get snapshot details using its ID and the default Dev Hub org:\n<%= config.bin %> <%= command.id %> --snapshot 0Oo...",
6294
- "Get snapshot details using its name from a Dev Hub org with alias SnapshotDevHub:\n<%= config.bin %> <%= command.id %> --snapshot Dependencies --target-dev-hub SnapshotDevHub"
6365
+ "Create an org shape for the source org with alias SourceOrg:\n<%= config.bin %> <%= command.id %> --target-org SourceOrg"
6295
6366
  ],
6296
6367
  "flags": {
6297
6368
  "json": {
@@ -6309,16 +6380,17 @@
6309
6380
  "multiple": false,
6310
6381
  "type": "option"
6311
6382
  },
6312
- "target-dev-hub": {
6383
+ "target-org": {
6313
6384
  "aliases": [
6314
- "targetdevhubusername"
6385
+ "targetusername",
6386
+ "u"
6315
6387
  ],
6316
- "char": "v",
6388
+ "char": "o",
6317
6389
  "deprecateAliases": true,
6318
- "name": "target-dev-hub",
6390
+ "name": "target-org",
6319
6391
  "noCacheDefault": true,
6320
6392
  "required": true,
6321
- "summary": "Username or alias of the Dev Hub org. Not required if the `target-dev-hub` configuration variable is already set.",
6393
+ "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
6322
6394
  "hasDynamicHelp": true,
6323
6395
  "multiple": false,
6324
6396
  "type": "option"
@@ -6343,177 +6415,70 @@
6343
6415
  "hasDynamicHelp": false,
6344
6416
  "multiple": false,
6345
6417
  "type": "option"
6346
- },
6347
- "snapshot": {
6348
- "char": "s",
6349
- "description": "The IDs of scratch org snapshots start with 0Oo.",
6350
- "name": "snapshot",
6351
- "required": true,
6352
- "summary": "Name or ID of snapshot to retrieve.",
6353
- "hasDynamicHelp": false,
6354
- "multiple": false,
6355
- "type": "option"
6356
6418
  }
6357
6419
  },
6358
6420
  "hasDynamicHelp": true,
6359
6421
  "hiddenAliases": [],
6360
- "id": "org:get:snapshot",
6361
- "pluginAlias": "@salesforce/plugin-signups",
6362
- "pluginName": "@salesforce/plugin-signups",
6363
- "pluginType": "jit",
6364
- "strict": true,
6365
- "summary": "Get details about a scratch org snapshot.",
6366
- "enableJsonFlag": true,
6367
- "isESM": true,
6368
- "relativePath": [
6369
- "lib",
6370
- "commands",
6371
- "org",
6372
- "get",
6373
- "snapshot.js"
6374
- ],
6375
- "aliasPermutations": [
6376
- "force:org:snapshot:get",
6377
- "org:force:snapshot:get",
6378
- "org:snapshot:force:get",
6379
- "org:snapshot:get:force",
6380
- "force:snapshot:org:get",
6381
- "snapshot:force:org:get",
6382
- "snapshot:org:force:get",
6383
- "snapshot:org:get:force",
6384
- "force:snapshot:get:org",
6385
- "snapshot:force:get:org",
6386
- "snapshot:get:force:org",
6387
- "snapshot:get:org:force",
6388
- "force:org:get:snapshot",
6389
- "org:force:get:snapshot",
6390
- "org:get:force:snapshot",
6391
- "org:get:snapshot:force",
6392
- "force:get:org:snapshot",
6393
- "get:force:org:snapshot",
6394
- "get:org:force:snapshot",
6395
- "get:org:snapshot:force",
6396
- "force:get:snapshot:org",
6397
- "get:force:snapshot:org",
6398
- "get:snapshot:force:org",
6399
- "get:snapshot:org:force"
6400
- ],
6401
- "permutations": [
6402
- "org:get:snapshot",
6403
- "get:org:snapshot",
6404
- "get:snapshot:org",
6405
- "org:snapshot:get",
6406
- "snapshot:org:get",
6407
- "snapshot:get:org"
6408
- ]
6409
- },
6410
- "org:list:shape": {
6411
- "aliases": [
6412
- "force:org:shape:list"
6413
- ],
6414
- "args": {},
6415
- "deprecateAliases": true,
6416
- "description": "The output includes the alias, username, and ID of the source org, the status of the org shape creation, and more. Use the org ID to update your scratch org configuration file so you can create a scratch org based on this org shape.",
6417
- "examples": [
6418
- "List all org shapes you've created:\n<%= config.bin %> <%= command.id %>",
6419
- "List all org shapes in JSON format and write the output to a file:\n<%= config.bin %> <%= command.id %> --json > tmp/MyOrgShapeList.json"
6420
- ],
6421
- "flags": {
6422
- "json": {
6423
- "description": "Format output as json.",
6424
- "helpGroup": "GLOBAL",
6425
- "name": "json",
6426
- "allowNo": false,
6427
- "type": "boolean"
6428
- },
6429
- "flags-dir": {
6430
- "helpGroup": "GLOBAL",
6431
- "name": "flags-dir",
6432
- "summary": "Import flag values from a directory.",
6433
- "hasDynamicHelp": false,
6434
- "multiple": false,
6435
- "type": "option"
6436
- },
6437
- "verbose": {
6438
- "hidden": true,
6439
- "name": "verbose",
6440
- "summary": "List more information about each org shape.",
6441
- "allowNo": false,
6442
- "type": "boolean"
6443
- },
6444
- "loglevel": {
6445
- "deprecated": {
6446
- "message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SF_LOG_LEVEL` environment variable."
6447
- },
6448
- "hidden": true,
6449
- "name": "loglevel",
6450
- "hasDynamicHelp": false,
6451
- "multiple": false,
6452
- "type": "option"
6453
- }
6454
- },
6455
- "hasDynamicHelp": false,
6456
- "hiddenAliases": [],
6457
- "id": "org:list:shape",
6422
+ "id": "org:create:shape",
6458
6423
  "pluginAlias": "@salesforce/plugin-signups",
6459
6424
  "pluginName": "@salesforce/plugin-signups",
6460
6425
  "pluginType": "jit",
6461
6426
  "strict": true,
6462
- "summary": "List all org shapes you’ve created.",
6427
+ "summary": "Create a scratch org configuration (shape) based on the specified source org.",
6463
6428
  "enableJsonFlag": true,
6464
6429
  "isESM": true,
6465
6430
  "relativePath": [
6466
6431
  "lib",
6467
6432
  "commands",
6468
6433
  "org",
6469
- "list",
6434
+ "create",
6470
6435
  "shape.js"
6471
6436
  ],
6472
6437
  "aliasPermutations": [
6473
- "force:org:shape:list",
6474
- "org:force:shape:list",
6475
- "org:shape:force:list",
6476
- "org:shape:list:force",
6477
- "force:shape:org:list",
6478
- "shape:force:org:list",
6479
- "shape:org:force:list",
6480
- "shape:org:list:force",
6481
- "force:shape:list:org",
6482
- "shape:force:list:org",
6483
- "shape:list:force:org",
6484
- "shape:list:org:force",
6485
- "force:org:list:shape",
6486
- "org:force:list:shape",
6487
- "org:list:force:shape",
6488
- "org:list:shape:force",
6489
- "force:list:org:shape",
6490
- "list:force:org:shape",
6491
- "list:org:force:shape",
6492
- "list:org:shape:force",
6493
- "force:list:shape:org",
6494
- "list:force:shape:org",
6495
- "list:shape:force:org",
6496
- "list:shape:org:force"
6438
+ "force:org:shape:create",
6439
+ "org:force:shape:create",
6440
+ "org:shape:force:create",
6441
+ "org:shape:create:force",
6442
+ "force:shape:org:create",
6443
+ "shape:force:org:create",
6444
+ "shape:org:force:create",
6445
+ "shape:org:create:force",
6446
+ "force:shape:create:org",
6447
+ "shape:force:create:org",
6448
+ "shape:create:force:org",
6449
+ "shape:create:org:force",
6450
+ "force:org:create:shape",
6451
+ "org:force:create:shape",
6452
+ "org:create:force:shape",
6453
+ "org:create:shape:force",
6454
+ "force:create:org:shape",
6455
+ "create:force:org:shape",
6456
+ "create:org:force:shape",
6457
+ "create:org:shape:force",
6458
+ "force:create:shape:org",
6459
+ "create:force:shape:org",
6460
+ "create:shape:force:org",
6461
+ "create:shape:org:force"
6497
6462
  ],
6498
6463
  "permutations": [
6499
- "org:list:shape",
6500
- "list:org:shape",
6501
- "list:shape:org",
6502
- "org:shape:list",
6503
- "shape:org:list",
6504
- "shape:list:org"
6464
+ "org:create:shape",
6465
+ "create:org:shape",
6466
+ "create:shape:org",
6467
+ "org:shape:create",
6468
+ "shape:org:create",
6469
+ "shape:create:org"
6505
6470
  ]
6506
6471
  },
6507
- "org:list:snapshot": {
6472
+ "org:create:snapshot": {
6508
6473
  "aliases": [
6509
- "force:org:snapshot:list"
6474
+ "force:org:snapshot:create"
6510
6475
  ],
6511
6476
  "args": {},
6512
6477
  "deprecateAliases": true,
6513
- "description": "You can view all the snapshots in a Dev Hub that you have access to. If you’re an admin, you can see all snapshots associated with the Dev Hub org. If you’re a user, you can see only your snapshots unless a Dev Hub admin gives you View All permissions.\n\nTo create a snapshot, use the \"<%= config.bin %> org create snapshot\" command. To get details about a snapshot request, use \"<%= config.bin %> org get snapshot\".",
6478
+ "description": "A snapshot is a point-in-time copy of a scratch org. The copy is referenced by its unique name in a scratch org definition file.\n\nUse \"<%= config.bin %> org get snapshot\" to get details, including status, about a snapshot creation request.\n\nTo create a scratch org from a snapshot, include the \"snapshot\" option (instead of \"edition\") in the scratch org definition file and set it to the name of the snapshot. Then use \"<%= config.bin %> org create scratch\" to create the scratch org.",
6514
6479
  "examples": [
6515
- "List snapshots in the default Dev Hub:\n<%= config.bin %> <%= command.id %>",
6516
- "List snapshots in the Dev Hub with alias SnapshotDevHub:\n<%= config.bin %> <%= command.id %> --target-dev-hub SnapshotDevHub"
6480
+ "Create a snapshot called \"Dependencies\" using the source scratch org ID and your default Dev Hub org:\n<%= config.bin %> <%= command.id %> --source-org 00Dxx0000000000 --name Dependencies --description 'Contains PackageA v1.1.0'",
6481
+ "Create a snapshot called \"NightlyBranch\" using the source scratch org username and a Dev Hub org with alias NightlyDevHub:\n<%= config.bin %> <%= command.id %> --source-org myuser@myorg --name NightlyBranch --description 'Contains PkgA v2.1.0 and PkgB 3.3.0' --target-dev-hub NightlyDevHub"
6517
6482
  ],
6518
6483
  "flags": {
6519
6484
  "json": {
@@ -6565,58 +6530,93 @@
6565
6530
  "hasDynamicHelp": false,
6566
6531
  "multiple": false,
6567
6532
  "type": "option"
6533
+ },
6534
+ "source-org": {
6535
+ "aliases": [
6536
+ "sourceorg"
6537
+ ],
6538
+ "char": "o",
6539
+ "deprecateAliases": true,
6540
+ "name": "source-org",
6541
+ "required": true,
6542
+ "summary": "ID or locally authenticated username or alias of scratch org to snapshot.",
6543
+ "hasDynamicHelp": false,
6544
+ "multiple": false,
6545
+ "type": "option"
6546
+ },
6547
+ "name": {
6548
+ "aliases": [
6549
+ "snapshotname"
6550
+ ],
6551
+ "char": "n",
6552
+ "deprecateAliases": true,
6553
+ "name": "name",
6554
+ "required": true,
6555
+ "summary": "Unique name of snapshot.",
6556
+ "hasDynamicHelp": false,
6557
+ "multiple": false,
6558
+ "type": "option"
6559
+ },
6560
+ "description": {
6561
+ "char": "d",
6562
+ "description": "Use this description to document the contents of the snapshot. We suggest that you include a reference point, such as a version control system tag or commit ID.",
6563
+ "name": "description",
6564
+ "summary": "Description of snapshot.",
6565
+ "hasDynamicHelp": false,
6566
+ "multiple": false,
6567
+ "type": "option"
6568
6568
  }
6569
6569
  },
6570
6570
  "hasDynamicHelp": true,
6571
6571
  "hiddenAliases": [],
6572
- "id": "org:list:snapshot",
6572
+ "id": "org:create:snapshot",
6573
6573
  "pluginAlias": "@salesforce/plugin-signups",
6574
6574
  "pluginName": "@salesforce/plugin-signups",
6575
6575
  "pluginType": "jit",
6576
6576
  "strict": true,
6577
- "summary": "List scratch org snapshots.",
6577
+ "summary": "Create a snapshot of a scratch org.",
6578
6578
  "enableJsonFlag": true,
6579
6579
  "isESM": true,
6580
6580
  "relativePath": [
6581
6581
  "lib",
6582
6582
  "commands",
6583
6583
  "org",
6584
- "list",
6584
+ "create",
6585
6585
  "snapshot.js"
6586
6586
  ],
6587
6587
  "aliasPermutations": [
6588
- "force:org:snapshot:list",
6589
- "org:force:snapshot:list",
6590
- "org:snapshot:force:list",
6591
- "org:snapshot:list:force",
6592
- "force:snapshot:org:list",
6593
- "snapshot:force:org:list",
6594
- "snapshot:org:force:list",
6595
- "snapshot:org:list:force",
6596
- "force:snapshot:list:org",
6597
- "snapshot:force:list:org",
6598
- "snapshot:list:force:org",
6599
- "snapshot:list:org:force",
6600
- "force:org:list:snapshot",
6601
- "org:force:list:snapshot",
6602
- "org:list:force:snapshot",
6603
- "org:list:snapshot:force",
6604
- "force:list:org:snapshot",
6605
- "list:force:org:snapshot",
6606
- "list:org:force:snapshot",
6607
- "list:org:snapshot:force",
6608
- "force:list:snapshot:org",
6609
- "list:force:snapshot:org",
6610
- "list:snapshot:force:org",
6611
- "list:snapshot:org:force"
6588
+ "force:org:snapshot:create",
6589
+ "org:force:snapshot:create",
6590
+ "org:snapshot:force:create",
6591
+ "org:snapshot:create:force",
6592
+ "force:snapshot:org:create",
6593
+ "snapshot:force:org:create",
6594
+ "snapshot:org:force:create",
6595
+ "snapshot:org:create:force",
6596
+ "force:snapshot:create:org",
6597
+ "snapshot:force:create:org",
6598
+ "snapshot:create:force:org",
6599
+ "snapshot:create:org:force",
6600
+ "force:org:create:snapshot",
6601
+ "org:force:create:snapshot",
6602
+ "org:create:force:snapshot",
6603
+ "org:create:snapshot:force",
6604
+ "force:create:org:snapshot",
6605
+ "create:force:org:snapshot",
6606
+ "create:org:force:snapshot",
6607
+ "create:org:snapshot:force",
6608
+ "force:create:snapshot:org",
6609
+ "create:force:snapshot:org",
6610
+ "create:snapshot:force:org",
6611
+ "create:snapshot:org:force"
6612
6612
  ],
6613
6613
  "permutations": [
6614
- "org:list:snapshot",
6615
- "list:org:snapshot",
6616
- "list:snapshot:org",
6617
- "org:snapshot:list",
6618
- "snapshot:org:list",
6619
- "snapshot:list:org"
6614
+ "org:create:snapshot",
6615
+ "create:org:snapshot",
6616
+ "create:snapshot:org",
6617
+ "org:snapshot:create",
6618
+ "snapshot:org:create",
6619
+ "snapshot:create:org"
6620
6620
  ]
6621
6621
  },
6622
6622
  "ui-bundle:dev": {
@@ -7024,5 +7024,5 @@
7024
7024
  "requiresProject": true
7025
7025
  }
7026
7026
  },
7027
- "version": "2.156.3"
7027
+ "version": "2.156.5"
7028
7028
  }