[PLA-1660] Uploads latest tag

[leonardocustodio]

Type

enhancement

---

Description

• This PR enhances the Docker Hub push workflow by automatically tagging the built image as 'latest' and pushing it alongside the version-tagged image. This ensures that the 'latest' tag on Docker Hub always points to the most recent version of the image.

---

Changes walkthrough

	Relevant files
Enhancement	push-image-to-dockerhub.yml Add Latest Tag Push to Docker Hub Workflow                              .github/workflows/push-image-to-dockerhub.yml Added commands to tag the Docker image as 'latest' and push it to Docker Hub. +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 (d8499da)

[github-actions]

PR Review

⏱️ Estimated effort to review [1-5]	2, because the changes are straightforward and limited to a single workflow file. However, understanding the implications of tagging and pushing Docker images requires some domain knowledge.
🧪 Relevant tests	No
🔍 Possible issues	Possible Bug: If multiple branches are being pushed simultaneously, the 'latest' tag could point to a non-master branch build, which might not be intended.
🔒 Security concerns	No

Code feedback:

---

relevant file	.github/workflows/push-image-to-dockerhub.yml
suggestion	Consider adding a condition to ensure that the 'latest' tag is only updated from the master/main branch to avoid unintended updates from feature branches. [important]
relevant line	docker tag enjin/$DOCKER_REPOSITORY:$IMAGE_TAG enjin/$DOCKER_REPOSITORY:latest

---

relevant file	.github/workflows/push-image-to-dockerhub.yml
suggestion	It's a good practice to log out of Docker after pushing images to ensure that credentials are not left on the runner. Add docker logout at the end of the script. [medium]
relevant line	docker push enjin/$DOCKER_REPOSITORY:latest

---

---

✨ 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 environment variables with braces for better readability and maintainability. Consider using environment variables for DOCKERHUB_API_USERNAME, DOCKERHUB_API_TOKEN, DOCKER_REPOSITORY, and IMAGE_TAG in the docker login, docker build, and docker push commands to enhance security and maintainability. This approach allows for easier updates and better management of sensitive information. .github/workflows/push-image-to-dockerhub.yml [26-30] -docker login --username $DOCKERHUB_API_USERNAME --password $DOCKERHUB_API_TOKEN -docker build -t enjin/$DOCKER_REPOSITORY:$IMAGE_TAG . -docker push enjin/$DOCKER_REPOSITORY:$IMAGE_TAG -docker tag enjin/$DOCKER_REPOSITORY:$IMAGE_TAG enjin/$DOCKER_REPOSITORY:latest -docker push enjin/$DOCKER_REPOSITORY:latest +docker login --username ${DOCKERHUB_API_USERNAME} --password ${DOCKERHUB_API_TOKEN} +docker build -t enjin/${DOCKER_REPOSITORY}:${IMAGE_TAG} . +docker push enjin/${DOCKER_REPOSITORY}:${IMAGE_TAG} +docker tag enjin/${DOCKER_REPOSITORY}:${IMAGE_TAG} enjin/${DOCKER_REPOSITORY}:latest +docker push enjin/${DOCKER_REPOSITORY}:latest
	Add a conditional check to ensure the latest tag is only pushed from the main branch. Ensure that the docker push command for the latest tag is only executed for the main branch or a specific release branch to avoid overwriting the latest tag with development or feature branch builds. This can be achieved by adding a conditional step or job that checks the branch name before executing the docker push command for the latest tag. .github/workflows/push-image-to-dockerhub.yml [28-30] -docker push enjin/$DOCKER_REPOSITORY:$IMAGE_TAG -docker tag enjin/$DOCKER_REPOSITORY:$IMAGE_TAG enjin/$DOCKER_REPOSITORY:latest -docker push enjin/$DOCKER_REPOSITORY:latest +if [ "$BRANCH_NAME" == "main" ]; then + docker push enjin/$DOCKER_REPOSITORY:$IMAGE_TAG + docker tag enjin/$DOCKER_REPOSITORY:$IMAGE_TAG enjin/$DOCKER_REPOSITORY:latest + docker push enjin/$DOCKER_REPOSITORY:latest +fi

---

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