-
Notifications
You must be signed in to change notification settings - Fork 3
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
DUPLO-13650 Elide err when nil from fatal messages #26
DUPLO-13650 Elide err when nil from fatal messages #26
Conversation
We couldn't validate your eligibility for PR-Agent-Pro. Please register here. PR Description updated to latest commit (dd17024) |
We couldn't validate your eligibility for PR-Agent-Pro. Please register here. PR Analysis
PR Feedback💡 General suggestions: The changes made in this PR are clear and concise. However, it would be beneficial to add tests to verify the correct behavior of the updated error handling. 🤖 Code feedback:
✨ Usage guide:Overview:
With a configuration file, use the following template:
See the review usage page for a comprehensive guide on using this tool. |
## 2024-01-24 | ||
|
||
### Fixed | ||
- Improved error message format when a tenant is missing or not allowed. | ||
- Prevented appending a nil error object to fatal error messages. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
CHANGELOG.md update
User description
Change description
Fatal error messages will no longer append the err object to the end when it is nil.
This would appear as " %!s()" which looks like something went terribly wrong.
Type of change
Related issues
Fix DUPLO-13650
Type
Bug fix
Description
cmd/duplo-jit/main.go
, the error message format has been enhanced when a tenant is missing or not allowed.internal/util.go
, theFatal
function has been modified to prevent appending a nil error object to the error message.Changes walkthrough
main.go
Enhanced Error Message Format for Missing Tenants
cmd/duplo-jit/main.go
Improved the error message format when a tenant is missing or not
allowed.
util.go
Prevented Nil Error Object in Fatal Messages
internal/util.go
Modified the
Fatal
function to not append the error object when itis nil.
✨ Usage guide:
Overview:
The
describe
tool scans the PR code changes, and generates a description for the PR - title, type, summary, walkthrough and labels. The tool can be triggered automatically every time a new PR is opened, or can be invoked manually by commenting on a PR.When commenting, to edit configurations related to the describe tool (
pr_description
section), use the following template:With a configuration file, use the following template:
Enabling\disabling automation
meaning the
describe
tool will run automatically on every PR, will keep the original title, and will add the original user description above the generated description.the tool will replace every marker of the form
pr_agent:marker_name
in the PR description with the relevant content, wheremarker_name
is one of the following:type
: the PR type.summary
: the PR summary.walkthrough
: the PR walkthrough.Note that when markers are enabled, if the original PR description does not contain any markers, the tool will not alter the description at all.
Custom labels
The default labels of the
describe
tool are quite generic: [Bug fix
,Tests
,Enhancement
,Documentation
,Other
].If you specify custom labels in the repo's labels page or via configuration file, you can get tailored labels for your use cases.
Examples for custom labels:
Main topic:performance
- pr_agent:The main topic of this PR is performanceNew endpoint
- pr_agent:A new endpoint was added in this PRSQL query
- pr_agent:A new SQL query was added in this PRDockerfile changes
- pr_agent:The PR contains changes in the DockerfileThe list above is eclectic, and aims to give an idea of different possibilities. Define custom labels that are relevant for your repo and use cases.
Note that Labels are not mutually exclusive, so you can add multiple label categories.
Make sure to provide proper title, and a detailed and well-phrased description for each label, so the tool will know when to suggest it.
Utilizing extra instructions
The
describe
tool can be configured with extra instructions, to guide the model to a feedback tailored to the needs of your project.Be specific, clear, and concise in the instructions. With extra instructions, you are the prompter. Notice that the general structure of the description is fixed, and cannot be changed. Extra instructions can change the content or style of each sub-section of the PR description.
Examples for extra instructions:
Use triple quotes to write multi-line instructions. Use bullet points to make the instructions more readable.
More PR-Agent commands
See the describe usage page for a comprehensive guide on using this tool.