[PLA-1658] Adds matrix&canary v1005

[leonardocustodio]

Type

enhancement

---

Description

• Updated matrix version references in matrix.dart to v1005 for both canary and production.
• Added export statements for the new v1005 in both canary and production Dart files.
• Introduced new version files v1005.dart for both canary and production, enhancing the versioning support.

---

Changes walkthrough

Relevant files

Enhancement

matrix.dart Update matrix version references to v1005                                lib/consts/matrix/matrix.dart Updated canary() to return c.v1005. Updated production() to return p.v1005. +2/-2      canary.dart Add export for canary version v1005                                            lib/consts/matrix/canary/canary.dart Added export for v1005.dart. +1/-0      production.dart Add export for production version v1005                                    lib/consts/matrix/production/production.dart Added export for v1005.dart. +1/-0      v1005.dart Add canary version v1005 file                                                        lib/consts/matrix/canary/v1005.dart Added new canary version file v1005.dart. +3/-1      v1005.dart Add production version v1005 file                                                lib/consts/matrix/production/v1005.dart Added new production version file v1005.dart. +3/-1

---

✨ PR-Agent usage:
Comment /help on the PR to get a list of all available PR-Agent tools and their descriptions

[github-actions]

PR Description updated to latest commit (5a5ccc7)

[github-actions]

PR Review

⏱️ Estimated effort to review [1-5]	2, because the changes are straightforward and involve updating version references and exporting new version files. The logic is not complex, but attention to detail is required to ensure version consistency and correct exports.
🧪 Relevant tests	No
🔍 Possible issues	Version Consistency: Ensure that the version v1005 referenced in matrix.dart for both canary and production environments matches the actual version files v1005.dart in terms of API compatibility and expected functionality.
🔒 Security concerns	No

Code feedback:

---

relevant file	lib/consts/matrix/matrix.dart
suggestion	Consider adding a unit test to verify that the canary() and production() functions return the expected version strings. This can help catch any discrepancies in version naming or updates in the future. [important]
relevant line	return c.v1005;

---

relevant file	lib/consts/matrix/canary/canary.dart
suggestion	Ensure that the newly added v1005.dart file for canary is correctly implemented and exported. Double-check that all necessary components or classes are available and correctly structured within v1005.dart. [important]
relevant line	export 'v1005.dart';

---

relevant file	lib/consts/matrix/production/production.dart
suggestion	Similar to the canary version, verify that the v1005.dart file for production is correctly implemented and exported. Ensure that it aligns with the production environment's requirements and contains all necessary components. [important]
relevant line	export 'v1005.dart';

---

---

✨ Review tool 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.

[github-actions]

PR Code Suggestions

Category	Suggestions
Best practice	Use a constant for version numbers to simplify updates and improve maintainability. Consider creating a constant for the version number 'v1005' to ensure consistency across different files and to simplify future updates. This approach can help avoid manual errors and make the codebase more maintainable. lib/consts/matrix/canary/canary.dart [12] -export 'v1005.dart'; +const latestVersion = 'v1005'; +export '${latestVersion}.dart';
Enhancement	Dynamically fetch version numbers to ensure consistency and ease of updates. To ensure that the version used in canary() and production() always matches the latest, consider fetching the version dynamically from a single source of truth instead of hardcoding it. This could be a configuration file or a dedicated version management class. lib/consts/matrix/matrix.dart [5-9] -return c.v1005; -return p.v1005; +return c.latestVersion; +return p.latestVersion;

---

✨ Improve tool 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.