User description
Sorry, we do not accept changes directly against this repository. Please see
CONTRIBUTING.md for information on where and how to contribute instead.
Type
Bug fix
Description
- Added a condition in
syfttypes.go and v1beta1/syfttypes.go to return nil if the Type field is empty, which can occur in some cases such as when the object is returned from the watcher.
- Updated the required fields for several schemas in
zz_generated.openapi.go, removing some previously required fields.
- Updated the version of the
github.com/kubescape/k8s-interface package in go.mod and updated the corresponding checksums in go.sum.
Changes walkthrough
| Relevant files |
|---|
| Bug fix |
syfttypes.go
pkg/apis/softwarecomposition/syfttypes.go
Added a condition to return nil if the Type field is
empty, which can occur in some cases such as when the object
is returned from the watcher.
|
+5/-0 |
syfttypes.go
pkg/apis/softwarecomposition/v1beta1/syfttypes.go
Similar to the previous file, a condition was added to
return nil if the Type field is empty.
|
+5/-0 |
zz_generated.openapi.go
pkg/generated/openapi/zz_generated.openapi.go
Updated the required fields for several schemas, removing
some previously required fields.
|
+5/-6 |
|
| Dependencies |
go.mod
|
+1/-1 |
go.sum
go.sum
Updated the checksums for the
github.com/kubescape/k8s-interface package due to the
version update.
|
+2/-2 |
|
✨ 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:
/describe --pr_description.some_config1=... --pr_description.some_config2=...
With a configuration file, use the following template:
[pr_description]
some_config1=...
some_config2=...
Enabling\disabling automation
- When you first install the app, the default mode for the describe tool is:
pr_commands = ["/describe --pr_description.add_original_user_description=true"
"--pr_description.keep_original_user_title=true", ...]
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.
- Markers are an alternative way to control the generated description, to give maximal control to the user. If you set:
pr_commands = ["/describe --pr_description.use_description_markers=true", ...]
the tool will replace every marker of the form pr_agent:marker_name in the PR description with the relevant content, where marker_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 Dockerfile- ...
The 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:
[pr_description]
extra_instructions="""
- The PR title should be in the format: '<PR type>: <title>'
- The title should be short and concise (up to 10 words)
- ...
"""
Use triple quotes to write multi-line instructions. Use bullet points to make the instructions more readable.
|
More PR-Agent commands
To invoke the PR-Agent, add a comment using one of the following commands:
- /review: Request a review of your Pull Request.
- /describe: Update the PR title and description based on the contents of the PR.
- /improve [--extended]: Suggest code improvements. Extended mode provides a higher quality feedback.
- /ask <QUESTION>: Ask a question about the PR.
- /update_changelog: Update the changelog based on the PR's contents.
- /add_docs 💎: Generate docstring for new components introduced in the PR.
- /generate_labels 💎: Generate labels for the PR based on the PR's contents.
- /analyze 💎: Automatically analyzes the PR, and presents changes walkthrough for each component.
See the tools guide for more details.
To list the possible configuration parameters, add a /config comment.
|
See the describe usage page for a comprehensive guide on using this tool.
