Skip to content

Commit 33b900d

Browse files
committed
docs: clarify repo_owner parameter semantics
- Since "repo" is somewhat overloaded, clarify that it refers to the owner of the repository in the git forge. - Describe behavior of the `repo_owner` param in Gitlab's hierarchical ownership - Fix bug in examples for params `repo_url` and `source_url`
1 parent a8e6b9c commit 33b900d

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

docs/content/docs/guide/authoringprs.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -55,13 +55,13 @@ check out the code that is being tested.
5555
| headers | The request headers (see [below](#using-the-body-and-headers-in-a-pipelines-as-code-parameter)) | `{{headers['x-github-event']}}` | push |
5656
| pull_request_number | The pull or merge request number, only defined when we are in a `pull_request` event or push event occurred when pull request is merged. | `{{pull_request_number}}` | 1 |
5757
| repo_name | The repository name. | `{{repo_name}}` | pipelines-as-code |
58-
| repo_owner | The repository owner. | `{{repo_owner}}` | openshift-pipelines |
59-
| repo_url | The repository full URL. | `{{repo_url}}` | https:/github.com/repo/owner |
58+
| repo_owner | The repository owner in the git provider. (For VCS providers with owner hierarchies, e.g. GitLab's orgs; namespaces; groups; and subgroups, the full ownership slug is used) | `{{repo_owner}}` | openshift-pipelines |
59+
| repo_url | The repository full URL. | `{{repo_url}}` | https:/github.com/openshift-pipelines/pipelines-as-code |
6060
| revision | The commit full sha revision. | `{{revision}}` | 1234567890abcdef |
6161
| sender | The sender username (or account ID on some providers) of the commit. | `{{sender}}` | johndoe |
6262
| source_branch | The branch name where the event comes from. | `{{source_branch}}` | main |
6363
| git_tag | The Git tag pushed (only available for tag push events; otherwise empty `""`). | `{{git_tag}}` | v1.0 |
64-
| source_url | The source repository URL from where the event comes (same as the value `repo_url` for push events). | `{{source_url}}` | https:/github.com/repo/owner |
64+
| source_url | The source repository URL from where the event comes (same as the value `repo_url` for push events). | `{{source_url}}` | https:/github.com/openshift-pipelines/pipelines-as-code |
6565
| target_branch | The branch name on which the event targets (same as `source_branch` for push events). | `{{target_branch}}` | main |
6666
| target_namespace | The target namespace where the Repository has matched and the PipelineRun will be created. | `{{target_namespace}}` | my-namespace |
6767
| trigger_comment | The comment triggering the PipelineRun when using a [GitOps command]({{< relref "/docs/guide/running.md#gitops-command-on-pull-or-merge-request" >}}) (like `/test`, `/retest`) | `{{trigger_comment}}` | /merge-pr branch |

0 commit comments

Comments
 (0)