@salesforce/plugin-devops-center 1.4.0 → 2.0.0

package/messages/devops.project.update.md

@@ -0,0 +1,45 @@
+# summary
+
+Update a DevOps Center project.
+
+# description
+
+Update the name, description, or active status of a DevOps Center project. At least one of --name, --description, or --is-active must be provided.
+
+# flags.project-id.summary
+
+ID of the DevOps Center project to update.
+
+# flags.name.summary
+
+New name for the project.
+
+# flags.description.summary
+
+New description for the project.
+
+# flags.is-active.summary
+
+Set the project active status. Use --is-active to activate or --no-is-active to deactivate.
+
+# examples
+
+- Rename a project:
+
+      <%= config.bin %> <%= command.id %> --target-org my-devops-org --project-id 1Qg000000000001 --name "MyApp Release v2"
+
+- Update the description of a project:
+
+      <%= config.bin %> <%= command.id %> --target-org my-devops-org --project-id 1Qg000000000001 --description "Updated release description"
+
+- Deactivate a project:
+
+      <%= config.bin %> <%= command.id %> --target-org my-devops-org --project-id 1Qg000000000001 --no-is-active
+
+- Update all fields at once:
+
+      <%= config.bin %> <%= command.id %> --target-org my-devops-org --project-id 1Qg000000000001 --name "Archived App" --description "Archived" --no-is-active
+
+# error.NoFieldsProvided
+
+Provide at least one of --name, --description, or --is-active/--no-is-active.

package/messages/devops.promote.md

@@ -0,0 +1,61 @@
+# summary
+
+Promote work items or a pipeline stage to a target pipeline stage.
+
+# description
+
+Promote specific work items or all approved work items from a source stage to the target pipeline stage.
+
+Pass --work-item-id to promote one or more specific work items to the target stage.
+
+Pass --stage-id to promote all approved work items from that source stage to the target stage.
+
+Exactly one of --work-item-id or --stage-id must be provided.
+
+Use --deploy-all to deploy all metadata in the branch rather than only changes not yet in the target stage.
+
+# flags.target-stage-id.summary
+
+ID of the pipeline stage to promote to.
+
+# flags.work-item-id.summary
+
+ID of the work item to promote. Mutually exclusive with --stage-id.
+
+# flags.work-item-id.description
+
+Specify this flag multiple times to promote multiple work items in a single operation.
+
+# flags.stage-id.summary
+
+ID of the source pipeline stage whose approved work items will be promoted. Mutually exclusive with --work-item-id.
+
+# examples
+
+- Promote all approved work items from a source stage to a target stage:
+
+      <%= config.bin %> <%= command.id %> --target-org my-devops-org --stage-id 1QVxx0000000001 --target-stage-id 1QVxx0000000002
+
+- Promote a specific work item to a stage:
+
+      <%= config.bin %> <%= command.id %> --target-org my-devops-org --work-item-id 1fkxx0000000001 --target-stage-id 1QVxx0000000001
+
+- Promote multiple work items:
+
+      <%= config.bin %> <%= command.id %> --target-org my-devops-org --work-item-id 1fkxx0000000001 --work-item-id 1fkxx0000000002 --target-stage-id 1QVxx0000000001
+
+- Promote a stage with full deploy:
+
+      <%= config.bin %> <%= command.id %> --target-org my-devops-org --stage-id 1QVxx0000000001 --target-stage-id 1QVxx0000000002 --deploy-all
+
+# error.NoModeFlag
+
+Provide either --work-item-id to promote specific work items or --stage-id to promote all approved work items from a stage.
+
+# error.NoWorkItems
+
+No work items found to promote from the source stage. Make sure there are approved work items before promoting.
+
+# error.PromoteFailed
+
+Failed to promote: %s

package/messages/devops.promotion.complete.md

@@ -0,0 +1,47 @@
+# summary
+
+Deploy undeployed work items to a pipeline stage org.
+
+# 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.
+
+If no undeployed work items are found for the stage, the command exits successfully with no action taken.
+
+# flags.target-stage-id.summary
+
+ID of the out-of-sync pipeline stage to deploy to.
+
+# flags.work-item-id.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.
+
+# examples
+
+- Complete a promotion for an out-of-sync pipeline stage.
+
+      <%= config.bin %> <%= command.id %> --target-org my-devops-org --target-stage-id 1QV000000000001
+
+- Complete a promotion for a specific work item (e.g. first stage of a pipeline).
+
+      <%= config.bin %> <%= command.id %> --target-org my-devops-org --target-stage-id 1QV000000000001 --work-item-id 1fk000000000001
+
+- Complete a promotion with full deploy and a specific test level.
+
+      <%= config.bin %> <%= command.id %> --target-org my-devops-org --target-stage-id 1QV000000000001 --deploy-all --test-level RunLocalTests
+
+# info.NothingToDeploy
+
+No undeployed work items found for this stage.
+
+# error.StageNotFound
+
+Stage '%s' not found or has no associated pipeline.
+
+# error.ValidationFailed
+
+Pre-flight validation failed. Error type: %s. Details: %s
+
+# error.DeployFailed
+
+Deploy request failed: %s

package/messages/devops.request.status.md

@@ -0,0 +1,21 @@
+# summary
+
+Get the status of a request.
+
+# description
+
+Returns the current status of a request identified by its request token.
+
+# flags.request-token.summary
+
+Request token from the promote response.
+
+# examples
+
+- Get the status of a request:
+
+      <%= config.bin %> <%= command.id %> --target-org my-devops-org --request-token a0B000000000001
+
+# error.RequestNotFound
+
+Request %s not found. Check the request token and try again.

package/messages/devops.stage.environment.delete.md

@@ -0,0 +1,29 @@
+# summary
+
+Delete an environment from a DevOps Center pipeline stage.
+
+# description
+
+Removes the specified environment from the pipeline stage. The environment must belong to an inactive pipeline.
+
+# flags.pipeline-id.summary
+
+ID of the pipeline. Used to verify the pipeline is inactive before deleting.
+
+# flags.environment-id.summary
+
+ID of the environment to delete.
+
+# examples
+
+- Delete an environment:
+
+      <%= config.bin %> <%= command.id %> --target-org my-devops-org --pipeline-id 0XB000000000001 --environment-id 0Xe000000000001
+
+# error.PipelineAlreadyActive
+
+Pipeline %s is already active. Environments can only be removed from inactive pipelines.
+
+# error.EnvironmentNotFound
+
+Environment %s not found. Check the environment ID and try again.

package/messages/devops.work-item.combine.md

@@ -0,0 +1,39 @@
+# summary
+
+Prepare work items to be combined for custom promotion.
+
+# description
+
+Use this command when work items in the same stage share metadata or have dependencies. DevOps Center combines the selected work items so they can be promoted together during custom promotion.
+
+After running this command, use "sf devops work-item promote" with the parent work item ID to complete the promotion. The combined work items are promoted as a single unit.
+
+# flags.parent-work-item-id.summary
+
+ID of the parent work item.
+
+# flags.parent-work-item-id.description
+
+The parent work item is the primary work item that continues through the pipeline. Changes from all child work items are merged into the parent's branch during promotion.
+
+# flags.child-work-item-id.summary
+
+ID of a work item to combine.
+
+# flags.child-work-item-id.description
+
+Specify this flag multiple times to combine multiple work items with the parent.
+
+# flags.target-stage-id.summary
+
+ID of the pipeline stage to promote the combined work item to.
+
+# examples
+
+- Prepare three work items to be combined to prevent conflicts during promotion:
+
+      <%= config.bin %> <%= command.id %> --target-org my-devops-org --parent-work-item-id 0Wx000000000001 --child-work-item-id 0Wx000000000002 --child-work-item-id 0Wx000000000003 --target-stage-id 05S000000000002
+
+# error.NoPipeline
+
+No pipeline found for this project. Make sure the project has an associated pipeline.

package/messages/devops.work-item.prepare.md

@@ -0,0 +1,27 @@
+# summary
+
+Prepare a work item for one-off promotion between pipeline stages.
+
+# description
+
+Prepares a work item for one-off promotion by creating the necessary branches and pull requests in the source control repository. Run this command before running "sf devops work-item promote" for a one-off promotion.
+
+Use "sf devops work-item list" to find the work item ID and target stage ID for a project.
+
+# flags.work-item-id.summary
+
+ID of the work item to prepare for one-off promotion.
+
+# flags.target-stage-id.summary
+
+ID of the pipeline stage to promote the work item to.
+
+# examples
+
+- Prepare a work item for one-off promotion to the UAT stage:
+
+      <%= config.bin %> <%= command.id %> --target-org my-devops-org --work-item-id 0Wx000000000001 --target-stage-id 05S000000000002
+
+- Prepare a work item using a DevOps Center org username:
+
+      <%= config.bin %> <%= command.id %> --target-org devops-center@example.com --work-item-id 0Wx000000000001 --target-stage-id 05S000000000002