Closed Bezbran closed 9 months ago
PR Description updated to latest commit (https://github.com/armosec/kubecop/commit/9632dfcf795c6f20fb5336e6b4697899d7ff22ba)
isNamespaced
in values.yaml
to support running the application in a namespaced environment. It updates the main application and the rule binding store to use a new environment variable STORE_NAMESPACE
to store the namespace. It also updates the Helm templates and the tests for the rule binding store to reflect these changes.๐ก General suggestions: The PR is well-structured and the changes are clearly explained. It would be beneficial to ensure that the new feature is thoroughly tested in various scenarios to ensure it behaves as expected. Also, it would be good to check if there are any potential edge cases or error conditions that have not been handled.
Utilizing extra instructionsThe `review` tool can be configured with extra instructions, which can be used 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. Specify the relevant sub-tool, and the relevant aspects of the PR that you want to emphasize. Examples for extra instructions: ``` [pr_reviewer] # /review # extra_instructions=""" In the 'general suggestions' section, emphasize the following: - Does the code logic cover relevant edge cases? - Is the code logic clear and easy to understand? - Is the code logic efficient? ... """ ``` Use triple quotes to write multi-line instructions. Use bullet points to make the instructions more readable. |
How to enable\disable automation- When you first install PR-Agent app, the [default mode](https://github.com/Codium-ai/pr-agent/blob/main/Usage.md#github-app-automatic-tools) for the `review` tool is: ``` pr_commands = ["/review", ...] ``` meaning the `review` tool will run automatically on every PR, with the default configuration. Edit this field to enable/disable the tool, or to change the used configurations |
Auto-labelsThe `review` tool can auto-generate two specific types of labels for a PR: - a `possible security issue` label, that detects possible [security issues](https://github.com/Codium-ai/pr-agent/blob/tr/user_description/pr_agent/settings/pr_reviewer_prompts.toml#L136) (`enable_review_labels_security` flag) - a `Review effort [1-5]: x` label, where x is the estimated effort to review the PR (`enable_review_labels_effort` flag) |
Extra sub-toolsThe `review` tool provides a collection of possible feedbacks about a PR. It is recommended to review the [possible options](https://github.com/Codium-ai/pr-agent/blob/main/docs/REVIEW.md#enabledisable-features), and choose the ones relevant for your use case. Some of the feature that are disabled by default are quite useful, and should be considered for enabling. For example: `require_score_review`, `require_soc2_ticket`, and more. |
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 \ |
Suggestions | |||
---|---|---|---|
enhancement |
| ||
best practice |
| ||
maintainability |
| ||
reliability |
|
Enabling\disabling automationWhen you first install the app, the [default mode](https://github.com/Codium-ai/pr-agent/blob/main/Usage.md#github-app-automatic-tools) for the improve tool is: ``` pr_commands = ["/improve --pr_code_suggestions.summarize=true", ...] ``` meaning the `improve` tool will run automatically on every PR, with summarization enabled. Delete this line to disable the tool from running automatically. |
Utilizing extra instructionsExtra instructions are very important for the `improve` tool, since they enable to guide the model to suggestions that are more relevant to the specific needs of the project. Be specific, clear, and concise in the instructions. With extra instructions, you are the prompter. Specify relevant aspects that you want the model to focus on. Examples for extra instructions: ``` [pr_code_suggestions] # /improve # extra_instructions=""" Emphasize the following aspects: - Does the code logic cover relevant edge cases? - Is the code logic clear and easy to understand? - Is the code logic efficient? ... """ ``` Use triple quotes to write multi-line instructions. Use bullet points to make the instructions more readable. |
A note on code suggestions quality- While the current AI for code is getting better and better (GPT-4), it's not flawless. Not all the suggestions will be perfect, and a user should not accept all of them automatically. - Suggestions are not meant to be simplistic. Instead, they aim to give deep feedback and raise questions, ideas and thoughts to the user, who can then use his judgment, experience, and understanding of the code base. - Recommended to use the 'extra_instructions' field to guide the model to suggestions that are more relevant to the specific needs of the project, or use the [custom suggestions :gem:](https://github.com/Codium-ai/pr-agent/blob/main/docs/CUSTOM_SUGGESTIONS.md) tool - With large PRs, best quality will be obtained by using 'improve --extended' mode. |
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 \ |
@Bezbran Can you modify it to not be "store" specific but also applies to application profiles? Like, not just for rule bindings because I want to use this namespace also for application profiles storing.
@Bezbran Can you modify it to not be "store" specific but also applies to application profiles? Like, not just for rule bindings because I want to use this namespace also for application profiles storing.
I use "STORE_" to emphasize this is for all objects, not only binding...
:sparkles: Artifacts are available here.
:sparkles: Artifacts are available here.
:sparkles: Artifacts are available here.
Type
Enhancement, Tests
Description
isNamespaced
invalues.yaml
.STORE_NAMESPACE
to store the namespace.Changes walkthrough
2 files
main.go
Added namespace support in main.go
cmd/main.go - Added a new environment variable `STORE_NAMESPACE` to store the
namespace. - Updated the `NewRuleBindingK8sStore` function call to include
`storeNamespace`.
store.go
Added namespace support in rule binding store
pkg/rulebindingstore/store.go - Added `storeNamespace` to the `RuleBindingK8sStore` struct. - Updated the `NewRuleBindingK8sStore` function to accept
`storeNamespace` as an argument. - Updated the `StartController` function to use `storeNamespace` when
creating the informer.
3 files
store_test.go
Updated tests for rule binding store
pkg/rulebindingstore/store_test.go - Updated the `NewRuleBindingK8sStore` function calls in the tests to
include an empty string for `storeNamespace`.
ci.yaml
Added validation for namespaced Helm template in CI workflow
.github/workflows/ci.yaml - Added a new step to validate the namespaced Helm template.
namespaced-system-tests.yaml
Added namespaced system tests workflow
.github/workflows/namespaced-system-tests.yaml - Added a new GitHub Actions workflow for running system tests in a
namespaced environment.
5 files
runtime-rule-binding.crd.yaml
Added namespaced support in CRD
chart/kubecop/crds/runtime-rule-binding.crd.yaml - Added conditional logic to set the scope of the CRD to `Namespaced` if
`.Values.isNamespaced` is true.
controller-statefulset.yaml
Added namespaced support in controller statefulset template
chart/kubecop/templates/controller-statefulset.yaml - Added a new environment variable `STORE_NAMESPACE` that gets its value
from the pod's namespace if `.Values.isNamespaced` is true.
deamonset.yaml
Added namespaced support in daemonset template
chart/kubecop/templates/deamonset.yaml - Added a new environment variable `STORE_NAMESPACE` that gets its value
from the pod's namespace if `.Values.isNamespaced` is true.
default-rule-binding.yaml
Added namespaced support in default rule binding template
chart/kubecop/templates/default-rule-binding.yaml - Added the namespace of the release to the metadata of the default rule
binding if `.Values.isNamespaced` is true.
values.yaml
Added namespaced flag in values.yaml
chart/kubecop/values.yaml - Added a new value `isNamespaced` and set it to true.
โจ 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](https://github.com/Codium-ai/pr-agent/blob/main/Usage.md#github-app-automatic-tools) every time a new PR is opened, or can be invoked manually by commenting on a PR. When commenting, to edit [configurations](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/settings/configuration.toml#L46) 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](https://github.com/Codium-ai/pr-agent/blob/main/Usage.md#working-with-github-app), use the following template: ``` [pr_description] some_config1=... some_config2=... ```
Enabling\disabling automation
- When you first install the app, the [default mode](https://github.com/Codium-ai/pr-agent/blob/main/Usage.md#github-app-automatic-tools) 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](https://github.com/Codium-ai/pr-agent/blob/main/docs/DESCRIBE.md#handle-custom-labels-from-the-repos-labels-page-gem) 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 performance - `New endpoint` - pr_agent:A new endpoint was added in this PR - `SQL query` - pr_agent:A new SQL query was added in this PR - `Dockerfile 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.
Inline File Walkthrough ๐
For enhanced user experience, the `describe` tool can add file summaries directly to the "Files changed" tab in the PR page. This will enable you to quickly understand the changes in each file, while reviewing the code changes (diffs). To enable inline file summary, set `pr_description.inline_file_summary` in the configuration file, possible values are: - `'table'`: File changes walkthrough table will be displayed on the top of the "Files changed" tab, in addition to the "Conversation" tab. - `true`: A collapsable file comment with changes title and a changes summary for each file in the PR. - `false` (default): File changes walkthrough will be added only to the "Conversation" tab.
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: '
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 \