From 33b900d15dcaf71d6766f511732cc981d42bb4fe Mon Sep 17 00:00:00 2001 From: Andrew Thorp Date: Tue, 7 Oct 2025 12:01:06 -0400 Subject: [PATCH 1/2] 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` --- docs/content/docs/guide/authoringprs.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/content/docs/guide/authoringprs.md b/docs/content/docs/guide/authoringprs.md index 6275f6c4d7..2b25e981e2 100644 --- a/docs/content/docs/guide/authoringprs.md +++ b/docs/content/docs/guide/authoringprs.md @@ -55,13 +55,13 @@ check out the code that is being tested. | headers | The request headers (see [below](#using-the-body-and-headers-in-a-pipelines-as-code-parameter)) | `{{headers['x-github-event']}}` | push | | 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 | | repo_name | The repository name. | `{{repo_name}}` | pipelines-as-code | -| repo_owner | The repository owner. | `{{repo_owner}}` | openshift-pipelines | -| repo_url | The repository full URL. | `{{repo_url}}` | https:/github.com/repo/owner | +| 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 | +| repo_url | The repository full URL. | `{{repo_url}}` | https:/github.com/openshift-pipelines/pipelines-as-code | | revision | The commit full sha revision. | `{{revision}}` | 1234567890abcdef | | sender | The sender username (or account ID on some providers) of the commit. | `{{sender}}` | johndoe | | source_branch | The branch name where the event comes from. | `{{source_branch}}` | main | | git_tag | The Git tag pushed (only available for tag push events; otherwise empty `""`). | `{{git_tag}}` | v1.0 | -| 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 | +| 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 | | target_branch | The branch name on which the event targets (same as `source_branch` for push events). | `{{target_branch}}` | main | | target_namespace | The target namespace where the Repository has matched and the PipelineRun will be created. | `{{target_namespace}}` | my-namespace | | 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 | From dd2f79332074b02752daf85eb708aab6ff2c3e14 Mon Sep 17 00:00:00 2001 From: Chmouel Boudjnah Date: Thu, 9 Oct 2025 10:23:16 +0200 Subject: [PATCH 2/2] docs: add missing slashes to url in authoringprs Changed `repo_url` and `source_url` documentation in the pull request authoring guide to use proper URLs, aligning with documentation standards. Signed-off-by: Chmouel Boudjnah --- docs/content/docs/guide/authoringprs.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/content/docs/guide/authoringprs.md b/docs/content/docs/guide/authoringprs.md index 2b25e981e2..e555c00b2e 100644 --- a/docs/content/docs/guide/authoringprs.md +++ b/docs/content/docs/guide/authoringprs.md @@ -56,12 +56,12 @@ check out the code that is being tested. | 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 | | repo_name | The repository name. | `{{repo_name}}` | pipelines-as-code | | 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 | -| repo_url | The repository full URL. | `{{repo_url}}` | https:/github.com/openshift-pipelines/pipelines-as-code | +| repo_url | The repository full URL. | `{{repo_url}}` | | | revision | The commit full sha revision. | `{{revision}}` | 1234567890abcdef | | sender | The sender username (or account ID on some providers) of the commit. | `{{sender}}` | johndoe | | source_branch | The branch name where the event comes from. | `{{source_branch}}` | main | | git_tag | The Git tag pushed (only available for tag push events; otherwise empty `""`). | `{{git_tag}}` | v1.0 | -| 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 | +| source_url | The source repository URL from where the event comes (same as the value `repo_url` for push events). | `{{source_url}}` | | | target_branch | The branch name on which the event targets (same as `source_branch` for push events). | `{{target_branch}}` | main | | target_namespace | The target namespace where the Repository has matched and the PipelineRun will be created. | `{{target_namespace}}` | my-namespace | | 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 |