Adding server input

[dwertent]

Type

Enhancement

---

Description

This PR introduces a new server input to the scan command, workflows, and action inputs. This allows the user to specify a server when running the scan, workflows, or actions. The changes include:

• Addition of a new server option to the scan command in entrypoint.sh.
• Addition of a new server input to the workflows in .github/workflows/.
• Addition of a new server input to the action inputs in action.yml.
• Update of the documentation in README.md to include the new server input in the examples and the input table.

---

Changes walkthrough

	Relevant files
Enhancement	entrypoint.sh                                                                                              entrypoint.sh Added a new server option to the scan command. This allows the user to specify a server when running the scan. +2/-1
Configuration changes	example-fix-commit.yaml                                                                          .github/workflows/example-fix-commit.yaml Added a new server input to the workflow. This allows the user to specify a server when running the workflow. +3/-2 example-fix-pr-review.yaml                                                                    .github/workflows/example-fix-pr-review.yaml Added a new server input to the workflow. This allows the user to specify a server when running the workflow. +1/-0 example-scan-image.yaml                                                                          .github/workflows/example-scan-image.yaml Added a new server input to the workflow. This allows the user to specify a server when running the workflow. +1/-0 example-scan.yaml                                                                                      .github/workflows/example-scan.yaml Added a new server input to the workflow. This allows the user to specify a server when running the workflow. +1/-0 action.yml                                                                                                    action.yml Added a new server input to the action inputs. This allows the user to specify a server when running the action. +9/-4
Documentation	README.md                                                                                                      README.md Updated the documentation to include the new server input in the examples and the input table. +8/-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 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.

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.

[codiumai-pr-agent-free]

PR Description updated to latest commit (39c87bd)

[codiumai-pr-agent-free]

PR Analysis

• 🎯 Main theme: Adding server input to the scan command, workflows, and action inputs
• 📝 PR summary: This PR introduces a new server input to the scan command, workflows, and action inputs. This allows the user to specify a server when running the scan, workflows, or actions. The changes include addition of a new server option to the scan command in entrypoint.sh, addition of a new server input to the workflows in .github/workflows/, and addition of a new server input to the action inputs in action.yml.
• 📌 Type of PR: Enhancement
• 🧪 Relevant tests added: No
• ⏱️ Estimated effort to review [1-5]: 2, because the changes are straightforward and involve adding a new input option across several files.
• 🔒 Security concerns: No security concerns found

PR Feedback

💡 General suggestions: The PR is well structured and the changes are clear. It would be beneficial to add tests to verify the new functionality.

🤖 Code feedback:

---

relevant file	entrypoint.sh
suggestion	Consider validating the server input to ensure it's a valid URL before using it in the scan command. [important]
relevant line	server_opt=$([ -n "${INPUT_SERVER}" ] && echo --server "${INPUT_SERVER}" || echo "")

---

relevant file	.github/workflows/example-fix-commit.yaml
suggestion	Ensure that the server variable vars.KUBESCAPE_SERVER is properly set and documented. [medium]
relevant line	server: ${{ vars.KUBESCAPE_SERVER }}

---

relevant file	action.yml
suggestion	Add a default value for the server input if applicable, to ensure backward compatibility and ease of use. [medium]
relevant line	server:

---

---

✨ Usage guide:

---

Overview:
The review tool scans the PR code changes, and generates a PR review. The tool can be triggered automatically every time a new PR is opened, or can be invoked manually by commenting on any PR.
When commenting, to edit configurations related to the review tool (pr_reviewer section), use the following template:

/review --pr_reviewer.some_config1=... --pr_reviewer.some_config2=...

With a configuration file, use the following template:

[pr_reviewer]
some_config1=...
some_config2=...

Utilizing extra instructions The 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 code feedback 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 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

About the 'Code feedback' section The review tool provides several type of feedbacks, one of them is code suggestions. If you are interested only in the code suggestions, it is recommended to use the improve feature instead, since it dedicated only to code suggestions, and usually gives better results. Use the review tool if you want to get a more comprehensive feedback, which includes code suggestions as well.

Auto-labels The review tool can auto-generate two specific types of labels for a PR: a possible security issue label, that detects possible security issues (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-tools The review tool provides a collection of possible feedbacks about a PR. It is recommended to review the possible options, 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_review, enable_review_labels_effort, 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 <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 review usage page for a comprehensive guide on using this tool.