enhance: Add PipelineRun name in pr json marshalling #2313
Conversation
Summary of ChangesHello @zakisk, 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 focuses on enhancing the clarity of error messages within the system. Specifically, it modifies the JSON marshalling process for PipelineRun objects. When a marshalling operation fails, the resulting error message will now explicitly include the name of the PipelineRun, or its generated name if a direct name is not available. This change aims to provide more immediate and actionable information to developers, thereby improving the overall debuggability of the application. 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
enhancement
![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 enhances error handling by including the PipelineRun name in the JSON marshalling error message, which is a useful improvement for debugging. My review focuses on code consistency and maintainability. I've left one comment regarding an inconsistency in how PipelineRun identifiers are retrieved across the codebase, suggesting a potential follow-up to unify the logic.
zakisk
force-pushed
the
enhacnce-error-log-of-json-marshaling
branch
from
50c6e5a to
d4e2a92
Compare
|
can you add details test... etc or set as draft if iit's not raady? |
zakisk
force-pushed
the
enhacnce-error-log-of-json-marshaling
branch
from
d4e2a92 to
cca2299
Compare
zakisk
force-pushed
the
enhacnce-error-log-of-json-marshaling
branch
from
cca2299 to
fe38a89
Compare
theakshaypant
left a comment
theakshaypant
left a comment
There was a problem hiding this comment.
Is the goal for this change to help with debugging failures by adding prName in error logs? Or are there other reasons that I am missing.
yeah, exactly at the moment on validation error we don't know PipelineRun name |
|
can you do a proper description in commit and pr details? |
|
you updated the PR description but you have an empty git commit description, i donn't know why gitlint didn't bug you there, but it should have be |
gitlint doesn't fail on single line commit message, we need to change that |
zakisk
force-pushed
the
enhacnce-error-log-of-json-marshaling
branch
from
fe38a89 to
fc612e8
Compare
when a PipelineRun fails json marshalling in match.go we don't know which PipelineRun has syntax error if there are multiple PipelineRuns. this PR adds PipelineRun name along with Json marshalling error so that it is easy to track the issue. Signed-off-by: Zaki Shaikh <zashaikh@redhat.com>
zakisk
force-pushed
the
enhacnce-error-log-of-json-marshaling
branch
from
fc612e8 to
fbc5fd8
Compare
|
/lgtm |
![pipelines-as-code[bot]](https://avatars.githubusercontent.com/in/112592?s=60&v=4){kind=small}
There was a problem hiding this comment.
Congrats @zakisk your PR Has been approved 🎉
✅ Pull Request Approved
Approval Status:
- Required Approvals: 1
- Current Approvals: 1
👥 Reviewers Who Approved:
| Reviewer | Permission Level | Approval Status |
|---|---|---|
| @chmouel | admin |
✅ |
📝 Next Steps
- Ensure all required checks pass
- Comply with branch protection rules
- Request a maintainer to merge using the
/mergecommand (or merge it
directly if you have repository permission).
Automated by the PAC Boussole 🧭
3 participants
📝 Description of the Change
when a PipelineRun fails json marshalling in match.go we don't know which PipelineRun has syntax error if there are multiple PipelineRuns. this PR adds PipelineRun name along with Json marshalling error so that it is easy to track the issue.
👨🏻 Linked Jira
🔗 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.