Releaser

[kferrone]

Type

enhancement, documentation

---

Description

• Introduced a new release workflow that includes artifact compression, detailed release messages, and Slack notifications.
• Simplified the installer workflow by removing unnecessary inputs and updating the build spec.
• Updated the publish workflow to trigger only on tags prefixed with 'v' and to use the new release workflow.
• Removed the old Slack notification workflow.
• Updated the contributing guide to reflect the new build instructions.
• Changed the output binary name in the PyInstaller spec to duplocloud.

---

Changes walkthrough

	Relevant files
Enhancement	installer.yml Simplify Installer Workflow and Update Build Spec                .github/workflows/installer.yml Simplified the workflow by removing unnecessary inputs. Changed the PyInstaller build spec from cli.spec to installer.spec. Updated the artifact upload path to dist/duplocloud. +3/-81    publish.yml Update Publish Workflow to Use New Release Strategy            .github/workflows/publish.yml Modified tag push trigger to only act on tags prefixed with 'v'. Replaced the 'notify' job with a 'release' job that uses a new release workflow. +4/-4      release.yml Add New Release Workflow with Slack Notifications                .github/workflows/release.yml Introduced a new release workflow that includes artifact compression and Slack notifications. Builds a detailed release message including links to PyPi and Dockerhub. Compresses artifacts into tar.gz format for the release. +90/-0    slack-notify.yml Remove Deprecated Slack Notification Workflow                        .github/workflows/slack-notify.yml Removed the old Slack notification workflow. +0/-24    installer.spec Update PyInstaller Spec to Change Output Binary Name          installer.spec Changed the output binary name from cli to duplocloud. +1/-1
Documentation	CONTRIBUTING.md Update Build Instructions in Contributing Guide                    CONTRIBUTING.md Updated build instructions to use installer.spec instead of cli.spec. +1/-1

---

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

[qodo-merge-pro]

PR Description updated to latest commit (9b62b97)

• Copy walkthrough table to "Files Changed" Tab

[qodo-merge-pro]

PR Review

⏱️ Estimated effort to review [1-5]	2, because the changes are mostly about workflow adjustments and renaming, which are straightforward to review. The complexity is low, and the changes are well-documented in the PR description.
🧪 Relevant tests	No
🔍 Possible issues	Artifact Compression: The new release workflow compresses artifacts. Ensure that the compression process does not introduce issues with artifact integrity or deployment processes.
	Slack Notification: The switch to a new Slack notification mechanism should be tested to ensure messages are correctly formatted and sent to the intended channel.
🔒 Security concerns	No

---

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

[qodo-merge-pro]

PR Code Suggestions

Category	Suggestions
Enhancement	Add error handling to the PyInstaller step. Consider adding error handling for the PyInstaller step to ensure the workflow fails gracefully if the build process encounters an error. This can be achieved by using the set -e command before running pyinstaller, which will cause the script to exit immediately if a command exits with a non-zero status. .github/workflows/installer.yml [45] -run: pyinstaller installer.spec +run: | + set -e + pyinstaller installer.spec
	Add a check to ensure the 'dist' directory is not empty before creating a release. For the Create Release step, consider adding a step to check if the dist directory is not empty before attempting to create a release. This can prevent creating empty releases in case no artifacts are present. .github/workflows/release.yml [66] -- name: Create Release +- name: Check if 'dist' directory is not empty + run: | + if [ -z "$(ls -A dist)" ]; then + echo "No artifacts found in 'dist' directory, skipping release creation." + exit 0 + fi
Best practice	Refine the tag pattern for workflow triggers. It's recommended to specify a more precise tag pattern for triggering the workflow. Using 'v' as the pattern is a good practice as it ensures that only version tags (e.g., v1.0.0) trigger the workflow. This change has been made correctly, enhancing the clarity and predictability of the workflow triggers.* .github/workflows/publish.yml [6] -- 'v*' +- 'v[0-9]+.[0-9]+.[0-9]+'
	Ensure the artifact upload path correctly specifies the files to include. When specifying the path for the actions/upload-artifact step, it's a good practice to ensure the path is correctly set to include all necessary files. If duplocloud is a directory, this is correct. However, if it's intended to upload specific files, the path should be adjusted accordingly. .github/workflows/installer.yml [53] -path: dist/duplocloud +path: dist/duplocloud/*
Possible issue	Ensure the SLACK_CHANNEL_ID is correctly defined and referenced. In the Post to a Slack channel step, it's important to ensure that the SLACK_CHANNEL_ID is correctly defined and passed as an environment variable or directly in the workflow file. If it's intended to be a secret or a repository variable, double-check its availability and correct referencing. .github/workflows/release.yml [81] -channel-id: ${{ vars.SLACK_CHANNEL_ID }} +channel-id: ${{ secrets.SLACK_CHANNEL_ID }}

---

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