docs: clarify repo_owner parameter semantics
#2279
Conversation
Summary of ChangesHello @aThorp96, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request enhances the documentation by providing clearer definitions and accurate examples for key repository parameters. It aims to resolve ambiguities around the Highlights
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
🔍 PR Lint Feedback
|
pipelines-as-code
bot
added
the
documentation
- 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`
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request clarifies the semantics of the repo_owner parameter in the documentation and fixes incorrect example URLs for repo_url and source_url. The changes are clear and improve the documentation. I've found a small typo in the updated example URLs and provided a suggestion to fix it.
| | 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 | |
There was a problem hiding this comment.
There's a small typo in the example URLs for repo_url and source_url. They are missing a slash in https://.
| | 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 | | |
| | 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/openshift-pipelines/pipelines-as-code | |
There was a problem hiding this comment.
the gemini review was accurate, i pushed the fix to your branch in dd2f793 (#2279) so we can move forward
aThorp96
force-pushed
the
repo-owner-docs-clarification
branch
from
6ebaea6 to
33b900d
Compare
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 <chmouel@redhat.com>
📝 Description of the Change
repo_ownerparam in Gitlab's hierarchical ownershiprepo_urlandsource_url👨🏻 Linked Jira
None
🔗 Linked GitHub Issue
Fixes #
🚀 Type of Change
fix:)feat:)feat!:,fix!:)docs:)chore:)refactor:)enhance:)deps:)🧪 Testing Strategy
🤖 AI Assistance
If you have used AI assistance, please provide the following details:
Which LLM was used?
Extent of AI Assistance:
Important
If the majority of the code in this PR was generated by an AI, please add a
Co-authored-bytrailer to your commit message.For example:
Co-authored-by: Gemini gemini@google.com
Co-authored-by: ChatGPT noreply@chatgpt.com
Co-authored-by: Claude noreply@anthropic.com
Co-authored-by: Cursor noreply@cursor.com
Co-authored-by: Copilot Copilot@users.noreply.github.com
**💡You can use the script
./hack/add-llm-coauthor.shto automatically addthese co-author trailers to your commits.
✅ Submitter Checklist
fix:,feat:) matches the "Type of Change" I selected above.make testandmake lintlocally to check for and fix anyissues. For an efficient workflow, I have considered installing
pre-commit and running
pre-commit installtoautomate these checks.