Skip to content

Commit 57242a8

Browse files
authored
Merge pull request #49370 from rolfedh/RHDEVDOCS-4375
RHDEVDOCS-4375 Update "PAC command reference" topic to reflect CLI breaking changes from RNs
2 parents ec39683 + 81845c9 commit 57242a8

File tree

1 file changed

+21
-21
lines changed

1 file changed

+21
-21
lines changed

modules/op-pipelines-as-code-command-reference.adoc

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
:_content-type: REFERENCE
66
[id="pipelines-as-code-command-reference_{context}"]
7-
= {pac} command reference
7+
= {pac} command reference
88

99
[role="_abstract"]
1010
The `tkn-pac` CLI tool offers the following capabilities:
@@ -19,7 +19,7 @@ The `tkn-pac` CLI tool offers the following capabilities:
1919
[TIP]
2020
====
2121
You can use the commands corresponding to the capabilities for testing and experimentation, so that you don't have to make changes to the Git repository containing the application source code.
22-
====
22+
====
2323

2424
== Basic syntax
2525

@@ -43,15 +43,15 @@ $ tkn pac --help
4343
[options="header"]
4444
|===
4545

46-
| Command | Description
46+
| Command | Description
4747

48-
| `tkn pac bootstrap` | Installs and configures {pac} for Git repository hosting service providers, such as GitHub and GitHub Enterprise.
48+
| `tkn pac bootstrap` | Installs and configures {pac} for Git repository hosting service providers, such as GitHub and GitHub Enterprise.
4949

5050
| `tkn pac bootstrap --nightly` | Installs the nightly build of {pac}.
5151

52-
| `tkn pac bootstrap --route-url <public_url_to_ingress_spec>` | Overrides the OpenShift route URL.
52+
| `tkn pac bootstrap --route-url <public_url_to_ingress_spec>` | Overrides the OpenShift route URL.
5353

54-
By default, `tkn pac bootstrap` detects the OpenShift route, which is automatically associated with the {pac} controller service.
54+
By default, `tkn pac bootstrap` detects the OpenShift route, which is automatically associated with the {pac} controller service.
5555

5656
If you do not have an {product-title} cluster, it asks you for the public URL that points to the ingress endpoint.
5757

@@ -65,11 +65,11 @@ If you do not have an {product-title} cluster, it asks you for the public URL th
6565
[options="header"]
6666
|===
6767

68-
| Command | Description
68+
| Command | Description
6969

70-
| `tkn pac repo create` | Creates a new {pac} repository and a namespace based on the pipeline run template.
70+
| `tkn pac create repository` | Creates a new {pac} repository and a namespace based on the pipeline run template.
7171

72-
| `tkn pac repo list` | Lists all the {pac} repositories and displays the last status of the associated runs.
72+
| `tkn pac list` | Lists all the {pac} repositories and displays the last status of the associated runs.
7373

7474
| `tkn pac repo describe` | Describes a {pac} repository and the associated runs.
7575

@@ -81,15 +81,15 @@ If you do not have an {product-title} cluster, it asks you for the public URL th
8181
[options="header"]
8282
|===
8383

84-
| Command | Description
84+
| Command | Description
8585

86-
| `tkn pac generate` | Generates a simple pipeline run.
86+
| `tkn pac generate` | Generates a simple pipeline run.
8787

88-
When executed from the directory containing the source code, it automatically detects current Git information.
88+
When executed from the directory containing the source code, it automatically detects current Git information.
8989

90-
In addition, it uses basic language detection capability and adds extra tasks depending on the language.
90+
In addition, it uses basic language detection capability and adds extra tasks depending on the language.
9191

92-
For example, if it detects a `setup.py` file at the repository root, the link:https://hub.tekton.dev/tekton/task/pylint[pylint task] is automatically added to the generated pipeline run.
92+
For example, if it detects a `setup.py` file at the repository root, the link:https://hub.tekton.dev/tekton/task/pylint[pylint task] is automatically added to the generated pipeline run.
9393

9494
|===
9595

@@ -99,20 +99,20 @@ For example, if it detects a `setup.py` file at the repository root, the link:ht
9999
[options="header"]
100100
|===
101101

102-
| Command | Description
102+
| Command | Description
103103

104-
| `tkn pac resolve` | Executes a pipeline run as if it is owned by the {pac} on service.
104+
| `tkn pac resolve` | Executes a pipeline run as if it is owned by the {pac} on service.
105105

106-
| `tkn pac resolve -f .tekton/pull-request.yaml \| oc apply -f -` | Displays the status of a live pipeline run that uses the template in `.tekton/pull-request.yaml`.
106+
| `tkn pac resolve -f .tekton/pull-request.yaml \| oc apply -f -` | Displays the status of a live pipeline run that uses the template in `.tekton/pull-request.yaml`.
107107

108108
Combined with a Kubernetes installation running on your local machine, you can observe the pipeline run without generating a new commit.
109109

110110
If you run the command from a source code repository, it attempts to detect the current Git information and automatically resolve parameters such as current revision or branch.
111111

112-
| `tkn pac resolve -f .tekton/pr.yaml -p revision=main -p repo_name=<repository_name>` | Executes a pipeline run by overriding default parameter values derived from the Git repository.
112+
| `tkn pac resolve -f .tekton/pr.yaml -p revision=main -p repo_name=<repository_name>` | Executes a pipeline run by overriding default parameter values derived from the Git repository.
113113

114-
The `-f` option can also accept a directory path and apply the `tkn pac resolve` command on all `.yaml` or `.yml` files in that directory. You can also use the `-f` flag multiple times in the same command.
114+
The `-f` option can also accept a directory path and apply the `tkn pac resolve` command on all `.yaml` or `.yml` files in that directory. You can also use the `-f` flag multiple times in the same command.
115115

116-
You can override the default information gathered from the Git repository by specifying parameter values using the `-p` option. For example, you can use a Git branch as a revision and a different repository name.
116+
You can override the default information gathered from the Git repository by specifying parameter values using the `-p` option. For example, you can use a Git branch as a revision and a different repository name.
117117

118-
|===
118+
|===

0 commit comments

Comments
 (0)