Skip to content

Commit 91af4d6

Browse files
chmouelsavitaashture
authored andcommitted
Add private URL example to GitLab URL
Atm we do have in a note that private instances (i.e. self-hosted enterprise/private instances) of GitLab are not automatically detected. However we could make it easier for the developers to grasp what do we mean, by adding said field (even in a commented out fashion) in the example This commit add the url for example and as well make sure we use the word GitLab instead of gitlab by enforcing a rule with vale. https://issues.redhat.com/browse/SRVKP-3735
1 parent 25abf7e commit 91af4d6

File tree

8 files changed

+23
-14
lines changed

8 files changed

+23
-14
lines changed

.vale/styles/PaaC/GitLab.yml

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
extends: substitution
2+
message: Use '%s' instead of '%s'
3+
level: error
4+
scope: text
5+
nonword: false
6+
swap:
7+
"Gitlab": GitLab

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ Pipelines-as-Code features:
3636

3737
- `tkn-pac` plug-in for Tekton CLI for managing pipelines-as-code repositories and bootstrapping.
3838

39-
- Gitlab, Bitbucket Server, Bitbucket Cloud and GitHub through Webhook support.
39+
- GitLab, Bitbucket Server, Bitbucket Cloud and GitHub through Webhook support.
4040

4141
## Installation Guide
4242

@@ -101,7 +101,7 @@ Note that even if installing with GitHub application is the preferred installati
101101
supports other methods :
102102

103103
- GitHub direct Webhook
104-
- Gitlab public and private instances.
104+
- GitLab public and private instances.
105105
- Bitbucket Cloud
106106
- Bitbucket Server
107107

docs/content/_index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ An opinionated CI based on OpenShift Pipelines / Tekton.
1010

1111
Pipelines as code is a project allowing you to define your CI/CD using
1212
[Tekton](https://tekton.dev) PipelineRuns and Tasks in a file located in your
13-
source control management (SCM) system, such as GitHub or Gitlab. This file is
13+
source control management (SCM) system, such as GitHub or GitLab. This file is
1414
then used to automatically create a pipeline for a Pull Request or a Push to a
1515
branch.
1616

@@ -45,7 +45,7 @@ tracking using a Git workflow.
4545

4646
- Git events Filtering and support for separate pipelines for each event
4747

48-
- Gitlab, Bitbucket Server, Bitbucket Cloud and GitHub Webhook support.
48+
- GitLab, Bitbucket Server, Bitbucket Cloud and GitHub Webhook support.
4949

5050
- `tkn-pac` plug-in for Tekton CLI for managing pipelines-as-code repositories and bootstrapping.
5151

docs/content/dev/release-process.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ git tag v1.2.3
2828

2929
* After a while (gorelease takes sometime) If everything is fine you should
3030
have the new version set as pre-release in
31-
github.com/openshift-pipelines/pipelines-as-code/releases
31+
<https://github.com/openshift-pipelines/pipelines-as-code/releases>
3232

3333
* Edit the release like the other releases has been done with a snippet of the highlight of the release.
3434

docs/content/docs/guide/cli.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -319,7 +319,7 @@ There is no clean-up of the secret after the run.
319319

320320
{{< details "tkn pac webhook add" >}}
321321

322-
### Configure and create webhook secret for GitHub, Gitlab and Bitbucket Cloud provider
322+
### Configure and create webhook secret for GitHub, GitLab and Bitbucket Cloud provider
323323

324324
`tkn-pac webhook add [-n namespace]`: Allows you to add new webhook secret for a given provider and update the value of the new webhook secret in the existing `Secret` object used to interact with Pipelines-as-Code
325325

docs/content/docs/guide/incoming_webhook.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -149,7 +149,7 @@ The parameter value of `pull_request_number` will be set to `12345` when using t
149149

150150
### Using incoming webhook with webhook based providers
151151

152-
Webhook based providers (i.e: GitHub Webhook, Gitlab, Bitbucket etc..) supports
152+
Webhook based providers (i.e: GitHub Webhook, GitLab, Bitbucket etc..) supports
153153
incoming webhook, using the token provided in the git_provider section.
154154

155155
Here is an example of a Repository CRD matching the target branch main with a GitHub webhook provider:

docs/content/docs/install/gitlab.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
---
2-
title: Gitlab
2+
title: GitLab
33
weight: 13
44
---
55

6-
# Use Pipelines-as-Code with Gitlab Webhook
6+
# Use Pipelines-as-Code with GitLab Webhook
77

8-
Pipelines-As-Code supports on [Gitlab](https://www.gitlab.com) through a webhook.
8+
Pipelines-As-Code supports on [GitLab](https://www.gitlab.com) through a webhook.
99

1010
Follow the pipelines-as-code [installation](/docs/install/installation) according to your Kubernetes cluster.
1111

@@ -64,7 +64,7 @@ $ tkn pac create repo
6464

6565
### Create a `Repository` and configure webhook manually
6666

67-
* From the left navigation pane of your Gitlab repository, go to **settings** -->
67+
* From the left navigation pane of your GitLab repository, go to **settings** -->
6868
**Webhooks** tab.
6969

7070
* Go to your project and click on *Settings* and *"Webhooks"* from the sidebar on the left.
@@ -119,6 +119,7 @@ $ tkn pac create repo
119119
spec:
120120
url: "https://gitlab.com/group/project"
121121
git_provider:
122+
# url: "https://gitlab.example.com/ # Set this if you are using a private GitLab instance
122123
secret:
123124
name: "gitlab-webhook-config"
124125
# Set this if you have a different key in your secret
@@ -151,7 +152,7 @@ Below is the sample format for `tkn pac webhook add`
151152
$ tkn pac webhook add -n project-pipelines
152153
153154
✓ Setting up GitLab Webhook for Repository https://gitlab.com/repositories/project
154-
? Please enter the project ID for the repository you want to be configured,
155+
? Please enter the project ID for the repository you want to be configured,
155156
project ID refers to an unique ID (e.g. 34405323) shown at the top of your GitLab project : 17103
156157
👀 I have detected a controller url: https://pipelines-as-code-controller-openshift-pipelines.apps.awscl2.aws.ospqa.com
157158
? Do you want me to use it? Yes
@@ -169,7 +170,7 @@ $ tkn pac webhook add -n project-pipelines
169170

170171
There are two ways to update the provider token for the existing `Repository`:
171172

172-
### Update using tkn pac cli
173+
### Update using tkn pac CLI
173174

174175
* Use the [`tkn pac webhook update-token`](/docs/guide/cli) command which
175176
will update provider token for the existing Repository CR.
@@ -197,6 +198,7 @@ You can find the secret name in the `Repository` CR.
197198
```yaml
198199
spec:
199200
git_provider:
201+
# url: "https://gitlab.example.com/ # Set this if you are using a private GitLab instance
200202
secret:
201203
name: "gitlab-webhook-config"
202204
```

docs/content/docs/install/overview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,6 @@ preferences the preferred install method is the GitHub Application method.
3434

3535
* [GitHub Application](/docs/install/github_apps).
3636
* [GitHub Webhook](/docs/install/github_webhook)
37-
* [Gitlab](/docs/install/gitlab)
37+
* [GitLab](/docs/install/gitlab)
3838
* [Bitbucket Server](/docs/install/bitbucket_server)
3939
* [Bitbucket Cloud](/docs/install/bitbucket_cloud)

0 commit comments

Comments
 (0)