Changing release artifact names #578

slashben · 2024-02-15T14:47:29Z

User description

Overview

This PR changes the names of release artifacts in the Regolibrary release and changes the go-module to take the new release names. It also preserves old release artifacts under the old name to enable backward compatibility in for older Kubescapes.

This is the first PR to mitigate #577

Type

enhancement, documentation

Description

Renamed artifact file names in gitregostore/gitstoreutils.go to include a '-v2' suffix for frameworks, security frameworks, controls, rules, and exceptions to support v2 release.
Updated the GitHub Actions workflow in .github/workflows/create-release.yaml to:
- Rename v1 assets to v2 during the release process.
- Download and preserve old v1 assets for backward compatibility.
- Add an important note in the release artifacts about the renaming and preservation of v1 assets, addressing issue Cannot add new controls that uses previously unknown objects to Kubescape #577.

Changes walkthrough

Relevant files

Enhancement

gitstoreutils.go `Renaming Artifact File Names to Support v2 Release` gitregostore/gitstoreutils.go Renamed artifact file names with a '-v2' suffix for frameworks, security frameworks, controls, rules, and exceptions.	+5/-5
create-release.yaml `Enhancing Release Workflow for v2 Assets and Backward Compatibility` .github/workflows/create-release.yaml Added steps to rename v1 assets to v2 in the release process. Downloaded old v1 assets and preserved them for backward compatibility. Added an important note in the release artifacts about the renaming and preservation of v1 assets.	+33/-0

✨ 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.
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: '<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.

Signed-off-by: Ben <[email protected]>

codiumai-pr-agent-free · 2024-02-15T14:47:54Z

PR Description updated to latest commit (7988051)

codiumai-pr-agent-free · 2024-02-15T14:48:13Z

PR Review

PR feedback
⏱️ Estimated effort to review [1-5]	2, because the changes are straightforward and localized to specific files with clear intentions. The renaming of artifacts and the addition of steps in the GitHub Actions workflow are well-documented and easy to follow.
🧪 Relevant tests	No
🔍 Possible issues	The renaming of artifacts might cause issues if external systems or scripts rely on the old naming convention without accommodating the new '-v2' suffix. The script assumes the download URLs for the v1 assets will always be available and reachable. If these URLs change or the assets are removed, the script will fail. Hardcoding the URL for the last v1 release (`LAST_V1_URL`) might make the script less flexible for future releases or changes in the repository structure.
🔒 Security concerns	No

✨ 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 'possible issues' 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
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_ticket`, and more.
Auto-approve PRs By invoking: `/review auto_approve` The tool will automatically approve the PR, and add a comment with the approval. To ensure safety, the auto-approval feature is disabled by default. To enable auto-approval, you need to actively set in a pre-defined configuration file the following: `[pr_reviewer] enable_auto_approval = true` (this specific flag cannot be set with a command line argument, only in the configuration file, committed to the repository) You can also enable auto-approval only if the PR meets certain requirements, such as that the `estimated_review_effort` is equal or below a certain threshold, by adjusting the flag: `[pr_reviewer] maximal_review_effort = 5`
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.

codiumai-pr-agent-free · 2024-02-15T14:48:16Z

PR Code Suggestions

Suggestions

best practice

Use a consistent naming convention for file names. Consider using a consistent naming convention for file names. The existing naming convention mixes underscores and hyphens. It's recommended to stick to one style for consistency and readability. gitregostore/gitstoreutils.go [26-33] -frameworksJsonFileName = "frameworks-v2.json" -securityFrameworksJsonFileName = "security_frameworks-v2.json" -controlsJsonFileName = "controls-v2.json" -rulesJsonFileName = "rules-v2.json" -systemPostureExceptionFileName = "exceptions-v2.json" +frameworksJsonFileName = "frameworks_v2.json" +securityFrameworksJsonFileName = "security_frameworks_v2.json" +controlsJsonFileName = "controls_v2.json" +rulesJsonFileName = "rules_v2.json" +systemPostureExceptionFileName = "exceptions_v2.json"
Check the success of the `mv` command and handle errors. It's recommended to check if the `mv` command was successful before proceeding. This can be done by checking the exit status of the command. If the `mv` command fails, the script should handle the error appropriately, possibly by logging an error message and exiting with a non-zero status code. .github/workflows/create-release.yaml [142] for i in "${!LIST_OF_V1_ASSETS[@]}"; do -mv "${REGO_ARTIFACT_PATH}/${LIST_OF_V1_ASSETS[$i]}" "${REGO_ARTIFACT_PATH}/${LIST_OF_V2_ASSETS[$i]}" + if ! mv "${REGO_ARTIFACT_PATH}/${LIST_OF_V1_ASSETS[$i]}" "${REGO_ARTIFACT_PATH}/${LIST_OF_V2_ASSETS[$i]}"; then + echo "Failed to move ${LIST_OF_V1_ASSETS[$i]} to ${LIST_OF_V2_ASSETS[$i]}" + exit 1 + fi done
Use a more descriptive variable name than `basename`. Consider using a more descriptive variable name than `basename`, which could be confused with the Unix command of the same name. A name like `asset_basename` would make the code clearer. .github/workflows/create-release.yaml [149] -basename=$(echo "${LIST_OF_V1_ASSETS[$i]}" \| sed 's/.json//') +asset_basename=$(echo "${LIST_OF_V1_ASSETS[$i]}" \| sed 's/.json//')

performance

Use bash parameter expansion instead of `sed` for removing file extensions. Instead of using `sed` to remove the `.json` extension, consider using bash parameter expansion for a more concise and efficient approach. This avoids spawning a subshell and calling an external program. .github/workflows/create-release.yaml [149] -basename=$(echo "${LIST_OF_V1_ASSETS[$i]}" \| sed 's/.json//') +basename="${LIST_OF_V1_ASSETS[$i]%.json}"

maintainability

Encapsulate asset downloading logic in a function for better readability and error handling.

To improve the readability and maintainability of the script, consider defining a function
for downloading assets. This function can encapsulate the logic for constructing the URL,
performing the download, and handling any errors.

.github/workflows/create-release.yaml [147-150]

-for i in "${!LIST_OF_V1_ASSETS[@]}"; do
-basename=$(echo "${LIST_OF_V1_ASSETS[$i]}" | sed 's/.json//')
-curl -s -f -L -o "${REGO_ARTIFACT_PATH}/${LIST_OF_V1_ASSETS[$i]}" "${LAST_V1_URL}${basename}"
+download_asset() {
+  local asset_name=$1
+  local base_url=$2
+  local destination_path=$3
+  local basename="${asset_name%.json}"
+  curl -s -f -L -o "${destination_path}/${asset_name}" "${base_url}${basename}" || {
+    echo "Failed to download ${asset_name}"
+    exit 1
+  }
+}
+
+for asset in "${LIST_OF_V1_ASSETS[@]}"; do
+  download_asset "$asset" "$LAST_V1_URL" "$REGO_ARTIFACT_PATH"
 done

✨ Usage guide:

Overview:
The improve tool scans the PR code changes, and automatically generates suggestions for improving the PR code. 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 improve tool (pr_code_suggestions section), use the following template:

/improve --pr_code_suggestions.some_config1=... --pr_code_suggestions.some_config2=...

With a configuration file, use the following template:

[pr_code_suggestions]
some_config1=...
some_config2=...

Enabling\disabling automation When you first install the app, the default mode 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 instructions Extra 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 💎 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 <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 improve usage page for a more comprehensive guide on using this tool.

YiscahLevySilas1 · 2024-02-20T07:54:05Z

@slashben we're going to have to create double objects in the gitRegoStore.. In order to support v2 api in the BE + the new apis, the BE needs to have both versions of the rego objects

YiscahLevySilas1 · 2024-02-20T07:59:05Z

gitregostore/gitstoreutils.go

 	frameworkControlRelationsFileName = "FWName_CID_CName.csv"
 	ControlRuleRelationsFileName      = "ControlID_RuleName.csv"


we need v2 version for the relations files too

slashben · 2024-02-24T22:37:23Z

Can you please make the changes?

…

On Tue, Feb 20, 2024 at 9:59 AM YiscahLevySilas1 ***@***.***> wrote: ***@***.**** commented on this pull request. ------------------------------ In gitregostore/gitstoreutils.go <#578 (comment)> : > frameworkControlRelationsFileName = "FWName_CID_CName.csv" ControlRuleRelationsFileName = "ControlID_RuleName.csv" we need v2 version for the relations files too — Reply to this email directly, view it on GitHub <#578 (review)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AODLOPUCNSQP4NYRJTCOZ6LYURJVJAVCNFSM6AAAAABDKMR6W2VHI2DSMVQWIX3LMV43YUDVNRWFEZLROVSXG5CSMV3GSZLXHMYTQOBZG4YDQMJQGM> . You are receiving this because you were mentioned.Message ID: ***@***.***>

YiscahLevySilas1 · 2024-03-28T13:01:15Z

was fixed in #605

slashben added 2 commits February 15, 2024 15:53

Changing release artifact names

0f62969

Signed-off-by: Ben <[email protected]>

edding issue ticket

7988051

Signed-off-by: Ben <[email protected]>

slashben requested review from YiscahLevySilas1 and yuleib February 15, 2024 14:47

codiumai-pr-agent-free bot added documentation Improvements or additions to documentation enhancement New feature or request labels Feb 15, 2024

codiumai-pr-agent-free bot added the Review effort [1-5]: 2 label Feb 15, 2024

YiscahLevySilas1 reviewed Feb 20, 2024

View reviewed changes

YiscahLevySilas1 closed this Mar 28, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Changing release artifact names #578

Changing release artifact names #578

slashben commented Feb 15, 2024 •

edited by codiumai-pr-agent-free bot

Loading

codiumai-pr-agent-free bot commented Feb 15, 2024

codiumai-pr-agent-free bot commented Feb 15, 2024

codiumai-pr-agent-free bot commented Feb 15, 2024 •

edited

Loading

YiscahLevySilas1 commented Feb 20, 2024

YiscahLevySilas1 Feb 20, 2024

slashben commented Feb 24, 2024 via email

YiscahLevySilas1 commented Mar 28, 2024

		frameworkControlRelationsFileName = "FWName_CID_CName.csv"
		ControlRuleRelationsFileName = "ControlID_RuleName.csv"

Changing release artifact names #578

Changing release artifact names #578

Conversation

slashben commented Feb 15, 2024 • edited by codiumai-pr-agent-free bot Loading

User description

Overview

Type

Description

Changes walkthrough

codiumai-pr-agent-free bot commented Feb 15, 2024

codiumai-pr-agent-free bot commented Feb 15, 2024

PR Review

codiumai-pr-agent-free bot commented Feb 15, 2024 • edited Loading

PR Code Suggestions

YiscahLevySilas1 commented Feb 20, 2024

YiscahLevySilas1 Feb 20, 2024

Choose a reason for hiding this comment

slashben commented Feb 24, 2024 via email

YiscahLevySilas1 commented Mar 28, 2024

slashben commented Feb 15, 2024 •

edited by codiumai-pr-agent-free bot

Loading

codiumai-pr-agent-free bot commented Feb 15, 2024 •

edited

Loading