fix: correcting config for python-semantic-release to work with poetry

[thompsonson]

Type

enhancement, documentation

---

Description

• Introduced __version__ attribute in det/__init__.py and added a module docstring.
• Automated version management in CI/CD pipeline by adding poetry run semantic-release version in .github/workflows/ci-cd.yml.
• Documented the initial version "v0.0.0" in README.md.
• Updated the build_command in pyproject.toml to include poetry publish, facilitating automatic package publishing.

---

Changes walkthrough

	Relevant files
Enhancement	__init__.py Initialize Module with Version and Docstring                          det/init.py Added module docstring. Introduced __version__ attribute with initial version "0.0.0". +3/-0      ci-cd.yml Automate Version Management in CI/CD Pipeline                        .github/workflows/ci-cd.yml Added a step to run poetry run semantic-release version before publishing. +1/-0      pyproject.toml Update Build Command to Include Publishing                              pyproject.toml Modified the build_command to include poetry publish after build. +1/-1
Documentation	README.md Document Initial Version in README                                              README.md Added a "Current Version" section with the initial version "v0.0.0". +4/-0

---

✨ 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 (362ccd9)

[github-actions]

PR Review

⏱️ Estimated effort to review [1-5]	2, because the changes are straightforward and focused on configuration and versioning. The PR introduces a version attribute, updates CI/CD workflow, and modifies the build command for publishing. The changes are well-documented and scoped, making the review process easier.
🧪 Relevant tests	No
🔍 Possible issues	The poetry publish command in .github/workflows/ci-cd.yml might fail without proper configuration for PyPI repository URL and credentials. It's crucial to ensure that PYPI_TOKEN is correctly set up in the repository's secrets.
	The version "0.0.0" introduced in det/__init__.py and README.md might conflict with semantic versioning practices if not intended as a placeholder for the initial development stage.
🔒 Security concerns	No

Code feedback:

---

relevant file	.github/workflows/ci-cd.yml
suggestion	Consider adding error handling or a verification step after poetry publish to ensure the publishing process completes successfully. This could be a simple script that checks the return status of the poetry publish command. [important]
relevant line	poetry run semantic-release version

---

relevant file	det/__init__.py
suggestion	Ensure that the versioning scheme in __version__ aligns with semantic versioning principles, especially if 0.0.0 is not intended to be a placeholder. Consider starting with a more conventional initial development version like 0.1.0. [medium]
relevant line	__version__ = "0.0.0"

---

relevant file	pyproject.toml
suggestion	Verify that all prerequisites for poetry publish are met, including authentication configuration for PyPI. This might involve setting up a .pypirc file or ensuring that environment variables are correctly passed to the publishing command. [important]
relevant line	build_command = "make cicd_setup && make install && poetry build && poetry publish"

---

---

✨ 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 semantic versioning for the package version. Consider using semantic versioning for the version attribute to facilitate better version management and compatibility checks in the future. det/init.py [3] -__version__ = "0.0.0" +__version__ = "0.1.0"
Enhancement	Ensure version updates in project files. Ensure that the semantic-release version command updates the version in pyproject.toml and init.py files, or consider using a plugin if necessary. .github/workflows/ci-cd.yml [77] -poetry run semantic-release version +poetry run semantic-release version --update pyproject.toml det/__init__.py
Maintainability	Automate version number updates in the README. Automate the update of the version number in the README to avoid manual updates and ensure consistency across documentation. README.md [11] -Rev: v0.0.0 +Rev: <!-- version -->0.0.0<!-- version-end -->
	Separate build and publish steps for clarity. Consider separating the build and publish steps in the build_command to enhance clarity and maintainability of the CI/CD pipeline. pyproject.toml [48] -build_command = "make cicd_setup && make install && poetry build && poetry publish" +build_command = "make cicd_setup && make install && poetry build" +publish_command = "poetry publish"

---

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