Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 48 additions & 0 deletions command-snapshot.json
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,22 @@
],
"plugin": "@salesforce/plugin-devops-center"
},
{
"alias": [],
"command": "devops:pipeline:get",
"flagAliases": [],
"flagChars": ["i", "o"],
"flags": ["api-version", "flags-dir", "json", "pipeline-id", "target-org"],
"plugin": "@salesforce/plugin-devops-center"
},
{
"alias": [],
"command": "devops:pipeline:list",
"flagAliases": [],
"flagChars": ["o"],
"flags": ["api-version", "flags-dir", "json", "target-org"],
"plugin": "@salesforce/plugin-devops-center"
},
{
"alias": [],
"command": "devops:pipeline:project:add",
Expand All @@ -28,6 +44,14 @@
"flags": ["api-version", "flags-dir", "json", "pipeline-id", "project-id", "target-org"],
"plugin": "@salesforce/plugin-devops-center"
},
{
"alias": [],
"command": "devops:pipeline:project:delete",
"flagAliases": [],
"flagChars": ["o"],
"flags": ["api-version", "flags-dir", "json", "pipeline-id", "project-id", "target-org"],
"plugin": "@salesforce/plugin-devops-center"
},
{
"alias": [],
"command": "devops:pipeline:stage:add",
Expand All @@ -36,6 +60,14 @@
"flags": ["api-version", "flags-dir", "json", "name", "next-stage-id", "pipeline-id", "target-org"],
"plugin": "@salesforce/plugin-devops-center"
},
{
"alias": [],
"command": "devops:pipeline:stage:delete",
"flagAliases": [],
"flagChars": ["o"],
"flags": ["api-version", "flags-dir", "json", "pipeline-id", "stage-id", "target-org"],
"plugin": "@salesforce/plugin-devops-center"
},
{
"alias": [],
"command": "devops:pipeline:update",
Expand All @@ -60,6 +92,14 @@
"flags": ["api-version", "flags-dir", "json", "target-org"],
"plugin": "@salesforce/plugin-devops-center"
},
{
"alias": [],
"command": "devops:project:update",
"flagAliases": [],
"flagChars": ["d", "i", "n", "o"],
"flags": ["api-version", "description", "flags-dir", "is-active", "json", "name", "project-id", "target-org"],
"plugin": "@salesforce/plugin-devops-center"
},
{
"alias": [],
"command": "devops:promote",
Expand Down Expand Up @@ -148,6 +188,14 @@
],
"plugin": "@salesforce/plugin-devops-center"
},
{
"alias": [],
"command": "devops:stage:environment:delete",
"flagAliases": [],
"flagChars": ["e", "o"],
"flags": ["api-version", "environment-id", "flags-dir", "json", "pipeline-id", "target-org"],
"plugin": "@salesforce/plugin-devops-center"
},
{
"alias": [],
"command": "devops:work-item:combine",
Expand Down
17 changes: 17 additions & 0 deletions messages/devops.pipeline.get.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# summary

Get details of a DevOps Center pipeline including its stages, repositories, and connected projects.

# description

Returns full details for a single DevOps Center pipeline: its stages in order, the source code repository and branch associated with each stage, and any connected projects.

# flags.pipeline-id.summary

ID of the DevOps Center pipeline.

# examples

- Get details for a specific pipeline:

<%= config.bin %> <%= command.id %> --target-org my-devops-org --pipeline-id 0Do000000000001
13 changes: 13 additions & 0 deletions messages/devops.pipeline.list.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# summary

List DevOps Center pipelines with their stages, repositories, and connected projects.

# description

Returns all DevOps Center pipelines in the org, including each pipeline's stages (in order), source code repository information per stage, and any connected projects.

# examples

- List all pipelines in the org:

<%= config.bin %> <%= command.id %> --target-org my-devops-org
25 changes: 25 additions & 0 deletions messages/devops.pipeline.project.delete.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# summary

Remove a DevOps Center project's connection to a pipeline.

# description

Deletes the junction record that connects the project to the pipeline. The project itself is not deleted.

# flags.pipeline-id.summary

ID of the pipeline.

# flags.project-id.summary

ID of the DevOps Center project.

# examples

- Remove a project from a pipeline using the project ID and pipeline ID.

<%= config.bin %> <%= command.id %> --target-org my-devops-org --pipeline-id 0XB000000000001 --project-id 0Hn000000000001

# error.ProjectNotAttached

Project %s is not attached to pipeline %s.
25 changes: 25 additions & 0 deletions messages/devops.pipeline.stage.delete.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# summary

Delete a stage from a DevOps Center pipeline.

# 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.

# flags.pipeline-id.summary

ID of the pipeline that contains the stage.

# flags.stage-id.summary

ID of the stage to delete.

# examples

- Delete a stage from a pipeline:

<%= config.bin %> <%= command.id %> --target-org my-devops-org --pipeline-id 0XB000000000001 --stage-id 0Xc000000000002

# error.StageNotFound

Stage %s not found in pipeline %s. Check the stage ID and try again.
45 changes: 45 additions & 0 deletions messages/devops.project.update.md
Original file line number Diff line number Diff line change
@@ -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.
29 changes: 29 additions & 0 deletions messages/devops.stage.environment.delete.md
Original file line number Diff line number Diff line change
@@ -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.
98 changes: 98 additions & 0 deletions schemas/devops-pipeline-get.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,98 @@
{
"$schema": "http://json-schema.org/draft-07/schema#",
"$ref": "#/definitions/PipelineGetResult",
"definitions": {
"PipelineGetResult": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": ["string", "null"]
},
"isActive": {
"type": "boolean"
},
"stages": {
"type": "array",
"items": {
"$ref": "#/definitions/PipelineStageDetail"
}
},
"connectedProjects": {
"type": "array",
"items": {
"$ref": "#/definitions/ConnectedProject"
}
}
},
"required": ["id", "name", "description", "isActive", "stages", "connectedProjects"],
"additionalProperties": false
},
"PipelineStageDetail": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": ["string", "null"]
},
"nextStageId": {
"type": ["string", "null"]
},
"branchName": {
"type": ["string", "null"]
},
"repositoryName": {
"type": ["string", "null"]
},
"repositoryOwner": {
"type": ["string", "null"]
},
"environment": {
"anyOf": [
{
"$ref": "#/definitions/StageEnvironment"
},
{
"type": "null"
}
]
}
},
"required": ["id", "name", "nextStageId", "branchName", "repositoryName", "repositoryOwner", "environment"],
"additionalProperties": false
},
"StageEnvironment": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": ["id", "name"],
"additionalProperties": false
},
"ConnectedProject": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": ["string", "null"]
}
},
"required": ["id", "name"],
"additionalProperties": false
}
}
}
38 changes: 38 additions & 0 deletions schemas/devops-pipeline-list.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
{
"$schema": "http://json-schema.org/draft-07/schema#",
"$ref": "#/definitions/PipelineListResult",
"definitions": {
"PipelineListResult": {
"type": "object",
"properties": {
"pipelines": {
"type": "array",
"items": {
"$ref": "#/definitions/DevopsPipeline"
}
}
},
"required": ["pipelines"],
"additionalProperties": false
},
"DevopsPipeline": {
"type": "object",
"properties": {
"Id": {
"type": "string"
},
"Name": {
"type": "string"
},
"Description": {
"type": ["string", "null"]
},
"IsActive": {
"type": "boolean"
}
},
"required": ["Id", "Name", "Description", "IsActive"],
"additionalProperties": false
}
}
}
Loading
Loading