Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(site): add missing document for "pipeline show/status" command #1201

Merged
merged 2 commits into from
Jul 29, 2020
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
8 changes: 4 additions & 4 deletions site/content/en/docs/Commands/pipeline/delete.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,24 @@
---
title: "pipeline delete"
linkTitle: "pipeline delete"
weight: 3
weight: 5
---

```bash
$ copilot pipeline delete [flags]
```

## What does it do?
### What does it do?
`copilot pipeline delete` deletes the pipeline associated with your workspace.

## What are the flags?
### What are the flags?
```bash
--delete-secret Deletes AWS Secrets Manager secret associated with a pipeline source repository.
-h, --help help for delete
--yes Skips confirmation prompt.
```

## Examples
### Examples
Delete the pipeline associated with your workspace.
```bash
$ copilot pipeline delete
Expand Down
29 changes: 29 additions & 0 deletions site/content/en/docs/Commands/pipeline/show.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
---
title: "pipeline show"
linkTitle: "pipeline show"
weight: 3
---
```bash
$ copilot pipeline show [flags]
```

### What does it do?
`copilot pipeline show` shows configuration information about a deployed pipeline for an application, including the account, region, and stages.

### What are the flags?
```bash
-a, --app string Name of the application.
-h, --help help for show
--json Optional. Outputs in JSON format.
-n, --name string Name of the pipeline.
--resources Optional. Show the resources in your pipeline.
```

### Examples
Shows info about the pipeline in the "myapp" application.
```bash
$ copilot pipeline show --app myapp --resources
```

### What does it look like?
<img class="img-fluid" src="https://raw.githubusercontent.com/kohidave/copilot-demos/master/pipeline-show.svg?sanitize=true">
28 changes: 28 additions & 0 deletions site/content/en/docs/Commands/pipeline/status.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
---
title: "pipeline status"
linkTitle: "pipeline status"
weight: 4
---
```bash
$ copilot pipeline status [flags]
```

### What does it do?
`copilot pipeline status` shows the status of the stages in a deployed pipeline.

### What are the flags?
```bash
-a, --app string Name of the application.
-h, --help help for status
--json Optional. Outputs in JSON format.
-n, --name string Name of the pipeline.
```

### Examples
Shows status of the pipeline "pipeline-myapp-myrepo".
```bash
$ copilot pipeline status -n pipeline-myapp-myrepo
```

### What does it look like?
<img class="img-fluid" src="https://raw.githubusercontent.com/kohidave/copilot-demos/master/pipeline-status.svg?sanitize=true">