SurfSense icon indicating copy to clipboard operation
SurfSense copied to clipboard

Adding UI build step to release workflow

Open anshul7665 opened this issue 6 months ago β€’ 5 comments

Adding UI build step to release workflow

Description

Adding UI Image Build and Push to GH Action using image refrence in docker compose

API Changes

  • [ ] This PR includes API changes

Types of changes

  • [ ] Bug fix (non-breaking change which fixes an issue)
  • [x] New feature (non-breaking change which adds functionality)
  • [ ] Performance improvement (non-breaking change which enhances performance)
  • [ ] Documentation update
  • [ ] Breaking change (fix or feature that would cause existing functionality to change)

Testing

  • [x] I have tested these changes locally
  • [ ] I have added/updated unit tests
  • [ ] I have added/updated integration tests

Checklist:

  • [x] My code follows the code style of this project
  • [ ] My change requires documentation updates
  • [x] I have updated the documentation accordingly
  • [ ] My change requires dependency updates
  • [x] I have updated the dependencies accordingly
  • [x] My code builds clean without any errors or warnings
  • [x] All new and existing tests passed

Summary by CodeRabbit

  • Chores
    • Updated workflow to separately build and push backend and UI Docker images.
    • Docker Compose configuration now pulls pre-built images from remote repositories instead of building locally.

anshul7665 avatar Jun 03 '25 06:06 anshul7665

@anshul7665 is attempting to deploy a commit to the Rohan Verma's projects Team on Vercel.

A member of the Team first needs to authorize it.

vercel[bot] avatar Jun 03 '25 06:06 vercel[bot]

"""

Walkthrough

This change updates the GitHub Actions workflow to separately build and push Docker images for the backend and UI components, renaming the backend job and adding a dedicated UI job. The docker-compose override configuration is also modified to pull these images from remote registries instead of building them locally.

Changes

File(s) Summary
.github/workflows/docker_build.yaml Renamed backend image build job, updated its build context, and added a new job for building and pushing the UI image.
docker-compose.override.yml Modified frontend and backend services to pull images from remote registries instead of building locally.

Sequence Diagram(s)

sequenceDiagram
    participant GitHub Actions
    participant Backend Docker Registry
    participant UI Docker Registry

    GitHub Actions->>GitHub Actions: tag_release job
    GitHub Actions->>GitHub Actions: build_and_push_backend_image (from surfsense_backend)
    GitHub Actions->>Backend Docker Registry: Push backend image
    GitHub Actions->>GitHub Actions: build_and_push_ui_image (from surfsense_web)
    GitHub Actions->>UI Docker Registry: Push UI image

Possibly related PRs

  • MODSetter/SurfSense#56: Extends the GitHub Actions workflow by renaming and splitting jobs for backend and UI Docker images.
  • MODSetter/SurfSense#122: Introduces a multi-architecture Docker build and push workflow with separate jobs for backend and frontend images.
  • MODSetter/SurfSense#96: Updates docker-compose.override.yml to use prebuilt images and modifies Docker image build workflows for backend and UI components.

Poem

πŸ‡ In GitHub’s meadow, builds take flight,
Backend and UI, both shining bright.
Images pushed with nimble grace,
Compose now fetches from their place.
A rabbit hops, with joy to sayβ€”
"New workflows bloom, hip-hip-hooray!"
πŸš€πŸ° """


πŸ“œ Recent review details

Configuration used: CodeRabbit UI Review profile: CHILL Plan: Pro

πŸ“₯ Commits

Reviewing files that changed from the base of the PR and between 285e0e34350408bc4021724bb077204252af4aef and 818706558affc3f594f20b020e20056353feed72.

πŸ“’ Files selected for processing (1)
  • docker-compose.override.yml (2 hunks)
βœ… Files skipped from review due to trivial changes (1)
  • docker-compose.override.yml

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❀️ Share
πŸͺ§ 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>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • 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 explain this code block.
    • @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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • 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/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

coderabbitai[bot] avatar Jun 03 '25 06:06 coderabbitai[bot]

Looks good to me. πŸ‘

MODSetter avatar Jun 04 '25 05:06 MODSetter

Coderabbit is right, the frontend and backend images are flipped in the Docker Compose

@anshul7665

MODSetter avatar Jun 04 '25 06:06 MODSetter

Flipped the image urls in docker compose

anshul7665 avatar Jun 04 '25 07:06 anshul7665