Skip to content

Commit

Permalink
common way of referring to tekton resources for user facing messages:…
Browse files Browse the repository at this point in the history
… PipelineRun
  • Loading branch information
danielhelfand authored and tekton-robot committed Jul 1, 2020
1 parent 35aff03 commit ef87250
Show file tree
Hide file tree
Showing 36 changed files with 165 additions and 168 deletions.
2 changes: 1 addition & 1 deletion docs/cmd/tkn.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ CLI for tekton pipelines
* [tkn condition](tkn_condition.md) - Manage conditions
* [tkn eventlistener](tkn_eventlistener.md) - Manage eventlisteners
* [tkn pipeline](tkn_pipeline.md) - Manage pipelines
* [tkn pipelinerun](tkn_pipelinerun.md) - Manage pipelineruns
* [tkn pipelinerun](tkn_pipelinerun.md) - Manage PipelineRuns
* [tkn resource](tkn_resource.md) - Manage pipeline resources
* [tkn task](tkn_task.md) - Manage Tasks
* [tkn taskrun](tkn_taskrun.md) - Manage TaskRuns
Expand Down
12 changes: 6 additions & 6 deletions docs/cmd/tkn_pipelinerun.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## tkn pipelinerun

Manage pipelineruns
Manage PipelineRuns

***Aliases**: pr,pipelineruns*

Expand All @@ -12,7 +12,7 @@ tkn pipelinerun

### Synopsis

Manage pipelineruns
Manage PipelineRuns

### Options

Expand All @@ -28,8 +28,8 @@ Manage pipelineruns

* [tkn](tkn.md) - CLI for tekton pipelines
* [tkn pipelinerun cancel](tkn_pipelinerun_cancel.md) - Cancel a PipelineRun in a namespace
* [tkn pipelinerun delete](tkn_pipelinerun_delete.md) - Delete pipelineruns in a namespace
* [tkn pipelinerun describe](tkn_pipelinerun_describe.md) - Describe a pipelinerun in a namespace
* [tkn pipelinerun list](tkn_pipelinerun_list.md) - Lists pipelineruns in a namespace
* [tkn pipelinerun logs](tkn_pipelinerun_logs.md) - Show the logs of PipelineRun
* [tkn pipelinerun delete](tkn_pipelinerun_delete.md) - Delete PipelineRuns in a namespace
* [tkn pipelinerun describe](tkn_pipelinerun_describe.md) - Describe a PipelineRun in a namespace
* [tkn pipelinerun list](tkn_pipelinerun_list.md) - Lists PipelineRuns in a namespace
* [tkn pipelinerun logs](tkn_pipelinerun_logs.md) - Show the logs of a PipelineRun

2 changes: 1 addition & 1 deletion docs/cmd/tkn_pipelinerun_cancel.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,5 +36,5 @@ Cancel the PipelineRun named 'foo' from namespace 'bar':

### SEE ALSO

* [tkn pipelinerun](tkn_pipelinerun.md) - Manage pipelineruns
* [tkn pipelinerun](tkn_pipelinerun.md) - Manage PipelineRuns

12 changes: 6 additions & 6 deletions docs/cmd/tkn_pipelinerun_delete.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## tkn pipelinerun delete

Delete pipelineruns in a namespace
Delete PipelineRuns in a namespace

***Aliases**: rm*

Expand All @@ -12,7 +12,7 @@ tkn pipelinerun delete

### Synopsis

Delete pipelineruns in a namespace
Delete PipelineRuns in a namespace

### Examples

Expand All @@ -28,13 +28,13 @@ or
### Options

```
--all Delete all pipelineruns in a namespace (default: false)
--all Delete all PipelineRuns in a namespace (default: false)
--allow-missing-template-keys If true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats. (default true)
-f, --force Whether to force deletion (default: false)
-h, --help help for delete
--keep int Keep n most recent number of pipelineruns
--keep int Keep n most recent number of PipelineRuns
-o, --output string Output format. One of: json|yaml|name|go-template|go-template-file|template|templatefile|jsonpath|jsonpath-file.
-p, --pipeline string The name of a pipeline whose pipelineruns should be deleted (does not delete the pipeline)
-p, --pipeline string The name of a Pipeline whose PipelineRuns should be deleted (does not delete the Pipeline)
--template string Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview].
```

Expand All @@ -49,5 +49,5 @@ or

### SEE ALSO

* [tkn pipelinerun](tkn_pipelinerun.md) - Manage pipelineruns
* [tkn pipelinerun](tkn_pipelinerun.md) - Manage PipelineRuns

12 changes: 6 additions & 6 deletions docs/cmd/tkn_pipelinerun_describe.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## tkn pipelinerun describe

Describe a pipelinerun in a namespace
Describe a PipelineRun in a namespace

***Aliases**: desc*

Expand All @@ -12,7 +12,7 @@ tkn pipelinerun describe

### Synopsis

Describe a pipelinerun in a namespace
Describe a PipelineRun in a namespace

### Examples

Expand All @@ -29,10 +29,10 @@ or

```
--allow-missing-template-keys If true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats. (default true)
-F, --fzf use fzf to select a pipelinerun to describe
-F, --fzf use fzf to select a PipelineRun to describe
-h, --help help for describe
-L, --last show description for last pipelinerun
--limit int lists number of pipelineruns when selecting a pipelinerun to describe (default 5)
-L, --last show description for last PipelineRun
--limit int lists number of PipelineRuns when selecting a PipelineRun to describe (default 5)
-o, --output string Output format. One of: json|yaml|name|go-template|go-template-file|template|templatefile|jsonpath|jsonpath-file.
--template string Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview].
```
Expand All @@ -48,5 +48,5 @@ or

### SEE ALSO

* [tkn pipelinerun](tkn_pipelinerun.md) - Manage pipelineruns
* [tkn pipelinerun](tkn_pipelinerun.md) - Manage PipelineRuns

12 changes: 6 additions & 6 deletions docs/cmd/tkn_pipelinerun_list.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## tkn pipelinerun list

Lists pipelineruns in a namespace
Lists PipelineRuns in a namespace

***Aliases**: ls*

Expand All @@ -12,7 +12,7 @@ tkn pipelinerun list

### Synopsis

Lists pipelineruns in a namespace
Lists PipelineRuns in a namespace

### Examples

Expand All @@ -28,14 +28,14 @@ List all PipelineRuns in a namespace 'foo':
### Options

```
-A, --all-namespaces list pipelineruns from all namespaces
-A, --all-namespaces list PipelineRuns from all namespaces
--allow-missing-template-keys If true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats. (default true)
-h, --help help for list
--label string A selector (label query) to filter on, supports '=', '==', and '!='
--limit int limit pipelineruns listed (default: return all pipelineruns)
--limit int limit PipelineRuns listed (default: return all PipelineRuns)
--no-headers do not print column headers with output (default print column headers with output)
-o, --output string Output format. One of: json|yaml|name|go-template|go-template-file|template|templatefile|jsonpath|jsonpath-file.
--reverse list pipelineruns in reverse order
--reverse list PipelineRuns in reverse order
--template string Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview].
```

Expand All @@ -50,5 +50,5 @@ List all PipelineRuns in a namespace 'foo':

### SEE ALSO

* [tkn pipelinerun](tkn_pipelinerun.md) - Manage pipelineruns
* [tkn pipelinerun](tkn_pipelinerun.md) - Manage PipelineRuns

18 changes: 9 additions & 9 deletions docs/cmd/tkn_pipelinerun_logs.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## tkn pipelinerun logs

Show the logs of PipelineRun
Show the logs of a PipelineRun

### Usage

Expand All @@ -10,19 +10,19 @@ tkn pipelinerun logs

### Synopsis

Show the logs of PipelineRun
Show the logs of a PipelineRun

### Examples

Show the logs of PipelineRun named 'foo' from namespace 'bar':

tkn pipelinerun logs foo -n bar

Show the logs of PipelineRun named 'microservice-1' for task 'build' only from namespace 'bar':
Show the logs of PipelineRun named 'microservice-1' for Task 'build' only from namespace 'bar':

tkn pr logs microservice-1 -t build -n bar

Show the logs of PipelineRun named 'microservice-1' for all tasks and steps (including init steps) from namespace 'foo':
Show the logs of PipelineRun named 'microservice-1' for all Tasks and steps (including init steps) from namespace 'foo':

tkn pr logs microservice-1 -a -n foo

Expand All @@ -32,11 +32,11 @@ Show the logs of PipelineRun named 'microservice-1' for all tasks and steps (inc
```
-a, --all show all logs including init steps injected by tekton
-f, --follow stream live logs
-F, --fzf use fzf to select a pipelinerun
-F, --fzf use fzf to select a PipelineRun
-h, --help help for logs
-L, --last show logs for last pipelinerun
--limit int lists number of pipelineruns (default 5)
-t, --task strings show logs for mentioned tasks only
-L, --last show logs for last PipelineRun
--limit int lists number of PipelineRuns (default 5)
-t, --task strings show logs for mentioned Tasks only
```

### Options inherited from parent commands
Expand All @@ -50,5 +50,5 @@ Show the logs of PipelineRun named 'microservice-1' for all tasks and steps (inc

### SEE ALSO

* [tkn pipelinerun](tkn_pipelinerun.md) - Manage pipelineruns
* [tkn pipelinerun](tkn_pipelinerun.md) - Manage PipelineRuns

10 changes: 5 additions & 5 deletions docs/man/man1/tkn-pipelinerun-delete.1
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

.SH NAME
.PP
tkn\-pipelinerun\-delete \- Delete pipelineruns in a namespace
tkn\-pipelinerun\-delete \- Delete PipelineRuns in a namespace


.SH SYNOPSIS
Expand All @@ -15,13 +15,13 @@ tkn\-pipelinerun\-delete \- Delete pipelineruns in a namespace

.SH DESCRIPTION
.PP
Delete pipelineruns in a namespace
Delete PipelineRuns in a namespace


.SH OPTIONS
.PP
\fB\-\-all\fP[=false]
Delete all pipelineruns in a namespace (default: false)
Delete all PipelineRuns in a namespace (default: false)

.PP
\fB\-\-allow\-missing\-template\-keys\fP[=true]
Expand All @@ -37,15 +37,15 @@ Delete pipelineruns in a namespace

.PP
\fB\-\-keep\fP=0
Keep n most recent number of pipelineruns
Keep n most recent number of PipelineRuns

.PP
\fB\-o\fP, \fB\-\-output\fP=""
Output format. One of: json|yaml|name|go\-template|go\-template\-file|template|templatefile|jsonpath|jsonpath\-file.

.PP
\fB\-p\fP, \fB\-\-pipeline\fP=""
The name of a pipeline whose pipelineruns should be deleted (does not delete the pipeline)
The name of a Pipeline whose PipelineRuns should be deleted (does not delete the Pipeline)

.PP
\fB\-\-template\fP=""
Expand Down
10 changes: 5 additions & 5 deletions docs/man/man1/tkn-pipelinerun-describe.1
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

.SH NAME
.PP
tkn\-pipelinerun\-describe \- Describe a pipelinerun in a namespace
tkn\-pipelinerun\-describe \- Describe a PipelineRun in a namespace


.SH SYNOPSIS
Expand All @@ -15,7 +15,7 @@ tkn\-pipelinerun\-describe \- Describe a pipelinerun in a namespace

.SH DESCRIPTION
.PP
Describe a pipelinerun in a namespace
Describe a PipelineRun in a namespace


.SH OPTIONS
Expand All @@ -25,19 +25,19 @@ Describe a pipelinerun in a namespace

.PP
\fB\-F\fP, \fB\-\-fzf\fP[=false]
use fzf to select a pipelinerun to describe
use fzf to select a PipelineRun to describe

.PP
\fB\-h\fP, \fB\-\-help\fP[=false]
help for describe

.PP
\fB\-L\fP, \fB\-\-last\fP[=false]
show description for last pipelinerun
show description for last PipelineRun

.PP
\fB\-\-limit\fP=5
lists number of pipelineruns when selecting a pipelinerun to describe
lists number of PipelineRuns when selecting a PipelineRun to describe

.PP
\fB\-o\fP, \fB\-\-output\fP=""
Expand Down
10 changes: 5 additions & 5 deletions docs/man/man1/tkn-pipelinerun-list.1
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

.SH NAME
.PP
tkn\-pipelinerun\-list \- Lists pipelineruns in a namespace
tkn\-pipelinerun\-list \- Lists PipelineRuns in a namespace


.SH SYNOPSIS
Expand All @@ -15,13 +15,13 @@ tkn\-pipelinerun\-list \- Lists pipelineruns in a namespace

.SH DESCRIPTION
.PP
Lists pipelineruns in a namespace
Lists PipelineRuns in a namespace


.SH OPTIONS
.PP
\fB\-A\fP, \fB\-\-all\-namespaces\fP[=false]
list pipelineruns from all namespaces
list PipelineRuns from all namespaces

.PP
\fB\-\-allow\-missing\-template\-keys\fP[=true]
Expand All @@ -37,7 +37,7 @@ Lists pipelineruns in a namespace

.PP
\fB\-\-limit\fP=0
limit pipelineruns listed (default: return all pipelineruns)
limit PipelineRuns listed (default: return all PipelineRuns)

.PP
\fB\-\-no\-headers\fP[=false]
Expand All @@ -49,7 +49,7 @@ Lists pipelineruns in a namespace

.PP
\fB\-\-reverse\fP[=false]
list pipelineruns in reverse order
list PipelineRuns in reverse order

.PP
\fB\-\-template\fP=""
Expand Down
Loading

0 comments on commit ef87250

Please sign in to comment.