Feat/GitHub actions docker publish

[fblgit]

Description

This PR Adds Github Docker Registry CI Build thru GH Actions.

Motivation and Context

Having the images ready to pull will simplify deployment at scale without requiring orgs to fork/build the application.

Changes Overview

Adds GH Actions to build CI images for x86 and ARM64

Types of changes

• [ ] New feature (non-breaking change which adds functionality)

Testing

• [ ] I have tested these changes locally

Checklist:

• [ ] My change requires documentation updates
• [ ] I have updated the documentation accordingly
• [ ] My code builds clean without any errors or warnings
• [ ] All new and existing tests passed

Summary by CodeRabbit

• Chores
  • Introduced automated workflows to build and publish backend and frontend Docker images for each push to the main branch.

[vercel[bot]]

@google-labs-jules[bot] 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.

[coderabbitai[bot]]

Walkthrough

A new GitHub Actions workflow file, "Docker Publish," has been added. This workflow runs on pushes to the main branch and contains two jobs: one to build and push a backend Docker image and another for the frontend. Both jobs target multiple architectures and publish images to GitHub Packages.

Changes

File(s)	Change Summary
.github/workflows/docker-publish.yml	Added workflow to build and push multi-architecture Docker images for backend and frontend apps.

Sequence Diagram(s)

sequenceDiagram
    participant GitHub as GitHub Actions
    participant Repo as Repository
    participant Docker as Docker Buildx
    participant GHCR as GitHub Container Registry

    GitHub->>Repo: On push to main, checkout code
    GitHub->>Docker: Setup QEMU and Buildx
    GitHub->>GHCR: Login using GitHub token
    GitHub->>Docker: Build backend image (multi-arch)
    Docker->>GHCR: Push backend image with labels
    GitHub->>Docker: Build frontend image (multi-arch)
    Docker->>GHCR: Push frontend image with labels

Poem

🐇
A workflow hops in, neat and new,
Building backend and frontend too.
With Docker magic, images fly—
To GitHub Packages, oh so spry!
Multi-arch dreams now realized,
In YAML fields, our code is prized.
Hoppity hooray for CI done right!

---

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

• 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>, 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.

[nwithan8]

Rabbit is wrong, github.repositoryUrl is correct: https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/accessing-contextual-information-about-workflow-runs#github-context

Looks good to me. Should add in addition to the sha tag (on a new line), a duplicate label with ":latest" as well.

[MODSetter]

@fblgit Thanks for this 👍 will test this and merge by EOD.

[anshul7665]

Should we tags images as semver ? more human readable

https://semver.org/

[fblgit]

hmmm.. the frontend package is not being pushed 👎 need some fix, also semver alignment should be followed, to keep consistency. @anshul7665 can u give a quick hand on this bro? im not really on the GH Actions thing ..

[nwithan8]

hmmm.. the frontend package is not being pushed 👎 need some fix, also semver alignment should be followed, to keep consistency. @anshul7665 can u give a quick hand on this bro? im not really on the GH Actions thing ..

The Actions file in this PR failed to run for both frontend and backend: https://github.com/MODSetter/SurfSense/actions/workflows/docker-publish.yml

There is a separate action that seems to have successfully pushed the backend (is not configured to do the same for the frontend): https://github.com/MODSetter/SurfSense/actions/workflows/docker_build.yaml

Obviously, don't want both actions running to avoid duplicates, but probably should use the working backend one as a reference to make a frontend variant.

[MODSetter]

@fblgit @nwithan8

Just wanted to let you guys know that @anshul7665 will take care of this in few days 👍

[anshul7665]

@nwithan8 , I am planning to extend the existing WORKING github action add additional job for frontend piece . For now I have removed the auto trigger for the other failing action . we can remove it later.

[anshul7665]

Added PR - https://github.com/MODSetter/SurfSense/pull/133

@nwithan8 @fblgit @MODSetter feel free to add your comments