Skip to content

Commit 13c5554

Browse files
committed
Update README getting started sample.
Update the example to the latest CLI changes. Remove siamaksade (404) repository and let the user know about creating a new directory for it. Closes #749 Signed-off-by: Chmouel Boudjnah <[email protected]>
1 parent 205efb8 commit 13c5554

File tree

1 file changed

+22
-25
lines changed

1 file changed

+22
-25
lines changed

README.md

Lines changed: 22 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -66,34 +66,31 @@ The flow for using pipelines as code generally begins with admin installing the
6666
creating a GitHub App and sharing the GitHub App URL across the organization for app teams to enable the app on their
6767
GitHub repositories.
6868

69-
To enable the GitHub App provided by admin on your Git repository as documented
69+
Start creating a GitHub repository by going to this URL
70+
<https://github.com/new>, you will need to provide a name (eg: `pac-demo`) and check
71+
the `"[ ] Add a README file"` box before pressing the `"Create Repository"` button.
72+
73+
You are now able to enable the `Pipelines as Code` Github Application as created
74+
by the Admin onto your new repository by following this guide
7075
[here](https://docs.github.com/en/developers/apps/managing-github-apps/installing-github-apps).
71-
Otherwise, you can go to the *Settings > Applications* and then click on
72-
*Configure* button near the GitHub App you had created. In the **Repository
73-
access** section, select the repositories that you want to enable and have
74-
access to Pipelines-as-code.
7576

76-
Once you have enabled your GitHub App for your GitHub repository, you can use the `pac` Tekton CLI plug-in to bootstrap
77-
pipelines as code:
77+
Once you have enabled your GitHub App for your GitHub repository, you can use
78+
the Tekton CLI [pac plug-in](https://pipelinesascode.com/docs/guide/cli/#install)
79+
to bootstrap pipelines as code:
7880

7981
```bash
80-
$ git clone https://github.com/siamaksade/pipeline-as-code-demo
81-
$ cd pipeline-as-code-demo
82-
$ tkn pac repository create
83-
84-
? Enter the namespace where the pipeline should run (default: pipelines-as-code): demo
85-
? Enter the Git repository url containing the pipelines (default: https://github.com/siamaksade/pipeline-as-code-demo):
86-
? Enter the target GIT branch (default: main):
87-
? Enter the Git event type for triggering the pipeline: pull_request
88-
! Namespace demo is not created yet
89-
? Would you like me to create the namespace demo? Yes
90-
✓ Repository pipeline-as-code-demo-pull-request has been created in demo namespace
91-
? Would you like me to create a basic PipelineRun file into the file .tekton/pull_request.yaml ? True
92-
✓ A basic template has been created in /Users/ssadeghi/Projects/pipelines/pac-demo/.tekton/pull_request.yaml, feel free to customize it.
93-
ℹ You can test your pipeline manually with : tkn-pac resolve -f .tekton/pull_request.yaml | kubectl create -f-
94-
ℹ Don't forget to install the GitHub application into your repo https://github.com/siamaksade/pipeline-as-code-demo
95-
✓ and we are done! enjoy :)))
96-
82+
$ git clone https://github.com/youruser/pac-demo
83+
$ cd pac-demo
84+
$ tkn pac create repository
85+
? Enter the Git repository url containing the pipelines (default: https://github.com/youruser/pac-demo):
86+
? Please enter the namespace where the pipeline should run (default: pac-demo):
87+
! Namespace pac-demo is not found
88+
? Would you like me to create the namespace pac-demo? (Y/n)
89+
? Would you like me to create the namespace pac-demo? Yes
90+
✓ Repository youruser-pac-demo has been created in pac-demo namespace
91+
✓ A basic template has been created in .tekton/pipelinerun.yaml, feel free to customize it.
92+
ℹ You can test your pipeline manually with: tkn-pac resolve -f .tekton/pipelinerun.yaml | kubectl create -f-
93+
🚀 You can use the command "tkn pac setup" to setup a repository with webhook
9794
```
9895

9996
The above command would create a `Repository` CRD in your `demo` namespace which is used to determine where the
@@ -108,7 +105,7 @@ supports other methods :
108105
- Bitbucket Cloud
109106
- Bitbucket Server
110107

111-
see the [INSTALL guide](https://pipelinesascode.com/docs/install/) more details on each install method.
108+
You can use the command `tkn pac setup` to help you setup webhooks on your repository. See the [INSTALL guide](https://pipelinesascode.com/docs/install/) for more details on each install method.
112109

113110
## Usage Guide
114111

0 commit comments

Comments
 (0)