kubescape / github-action

GitHub action to run Kubescape scans
Apache License 2.0
18 stars 20 forks source link

update README image scanning docs #51

Closed avinashupadhya99 closed 6 months ago

avinashupadhya99 commented 10 months ago

PR Type:

Documentation


PR Description:

This PR updates the README documentation to correct the image scanning example. The previous version incorrectly stated to replace image: "nginx" with the appropriate image name. This has been corrected to image: "quay.io/kubescape/kubescape".


PR Main Files Walkthrough:

files: `README.md`: The documentation for scanning images with Kubescape Github Action has been updated. The image name in the example has been corrected from `nginx` to `quay.io/kubescape/kubescape`.

User Description:

The example uses quay.io/kubescape/kubescape as the image and not nginx. This PR updates the line mentioning to replace image: "nginx" since it is misleading.

codiumai-pr-agent-free[bot] commented 10 months ago

PR Analysis

How to use

To invoke the PR-Agent, add a comment using one of the following commands: /review [-i]: Request a review of your Pull Request. For an incremental review, which only considers changes since the last review, include the '-i' option. /describe: Modify the PR title and description based on the contents of the PR. /improve [--extended]: Suggest improvements to the code in the PR. Extended mode employs several calls, and provides a more thorough feedback. /ask \<QUESTION>: Pose a question about the PR. /update_changelog: Update the changelog based on the PR's contents.

To edit any configuration parameter from configuration.toml, add --config_path=new_value For example: /review --pr_reviewer.extra_instructions="focus on the file: ..." To list the possible configuration parameters, use the /config command.