dpg-2227: added yml file for mfe module(engagement,fsm,tqm,pgr)

[nabeelmd-eGov]

Summary by CodeRabbit

• Chores
  • Introduced GitHub Actions workflows for automated Docker image builds for various UI services, enhancing deployment efficiency.

[coderabbitai]

Walkthrough

Walkthrough

This update introduces GitHub Actions workflows across multiple services (engagement UI, FSM UI, pgr UI, TQM UI) for building and pushing Docker images. Triggered by branch pushes and pull requests, these workflows automate the Docker image creation process, including environment setup, Docker build, and push to Docker Hub.

Changes

File Path	Change Summary
.github/workflows/...-docker.yml	New workflows for building/pushing Docker images for engagement UI, FSM UI, pgr UI, TQM UI services. Triggered by branch events, they include environment setup, Docker build, and Docker Hub push.

🐇✨
In a world of code and deploy,
A rabbit hopped, spreading joy.
"To Docker Hub!" was the cry,
As images took to the sky.
Each push and pull, a new toy,
In services vast, oh so coy.
🚀🌟

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

---

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit-tests for this file.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit tests for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository from git and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit tests.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• The JSON schema for the configuration file is available here.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

[coderabbitai]

Review Status

Actionable comments generated: 1

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between 5fe4467 and 2459b65.

Files selected for processing (4)

• .github/workflows/mfe-engagement-ui-docker.yml (1 hunks)
• .github/workflows/mfe-fsm-ui-docker.yml (1 hunks)
• .github/workflows/mfe-pgr-ui-docker.yml (1 hunks)
• .github/workflows/mfe-tqm-ui-docker.yml (1 hunks)

Additional comments: 7

.github/workflows/mfe-fsm-ui-docker.yml (4)

• 3-7: The trigger conditions for this workflow are clearly defined, ensuring that the Docker image build and push process is initiated only for relevant changes. This is a good practice for optimizing CI/CD pipeline efficiency.
• 20-25: Setting up environment variables for BRANCH_NAME, ACTION_NUMBER, and COMMIT_ID is done correctly. Using the last 8 characters of GITHUB_SHA for COMMIT_ID is a common practice for versioning. This setup is crucial for tagging Docker images in a meaningful way.
• 27-35: The Docker image build step is well-defined, including specifying the working directory and using environment variables to construct the IMAGE_TAG. This ensures that each Docker image is uniquely tagged with the branch name, commit ID, and action number, which is excellent for traceability.
• 37-49: The Docker Hub login and image push steps are securely handled using secrets for DOCKER_USERNAME and DOCKER_PASSWORD. Echoing the Docker password into the docker login command is a secure way to authenticate without exposing the password in logs. Pushing the Docker image with the constructed IMAGE_NAME ensures that the correct image is uploaded.

However, it's important to ensure that the Docker Hub repository (egovio/fsm-ui) exists and the provided Docker Hub account has the necessary permissions to push images to it.

.github/workflows/mfe-pgr-ui-docker.yml (1)

• 1-49: Given the similarity of this workflow file to the previous one reviewed (mfe-fsm-ui-docker.yml), the same comments and approvals apply. It's well-structured and follows best practices for building and pushing Docker images for the PGR UI service. Ensure that the Docker Hub repository (egovio/pgr-ui) exists and the provided Docker Hub account has the necessary permissions to push images to it.

.github/workflows/mfe-tqm-ui-docker.yml (1)

• 1-49: This workflow file for the TQM UI service mirrors the structure and logic of the previously reviewed files. It adheres to best practices for CI/CD workflows, including the use of secrets for Docker Hub credentials and unique tagging of Docker images. Ensure that the Docker Hub repository (egovio/tqm-ui) exists and the provided Docker Hub account has the necessary permissions to push images to it.

.github/workflows/mfe-engagement-ui-docker.yml (1)

• 1-49: This workflow file for the Engagement UI service is consistent with the others in terms of structure, logic, and best practices. It correctly uses GitHub Actions features and Docker commands to build and push Docker images. Ensure that the Docker Hub repository (egovio/engagement-ui) exists and the provided Docker Hub account has the necessary permissions to push images to it.

[coderabbitai]

Using actions/checkout@v3 with fetch-depth: 0 ensures that all history for tags and branches is fetched, which is necessary for certain operations that might depend on the full git history. However, for building Docker images, consider if you need the full history, as fetching less can speed up the checkout process.

Consider setting a specific fetch-depth value if the full history is not required for the Docker build process, to improve the efficiency of the checkout step.