Adding GH Action to build image and host them on GHCR
This PR introduces a GitHub Actions workflow to automate the process of building and pushing Docker images for the SurfSense backend.
Triggering: Can be manually triggered via workflow_dispatch with inputs for version bump type (patch, minor, major) and an optional branch to tag.
Version Management: Automatically calculates the next semantic version based on the latest Git tag and the specified bump type.
Tagging: Creates and pushes a new Git tag to the repository.
Summary by CodeRabbit
- Chores
- Introduced a new workflow to automate version tagging and Docker image building/pushing, triggered manually with customizable version bump options.
- Added a VERSION file indicating the initial version of the project.
@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.
Walkthrough
A new GitHub Actions workflow has been introduced to automate version tagging and Docker image building/pushing. The workflow is triggered manually and allows for semantic version bumping (patch, minor, major). It consists of two jobs: one that determines and creates the next version tag, and another that builds and pushes a Docker image to the GitHub Container Registry using the new tag. Additionally, a VERSION file with the value "0.0.1" has been added to the repository. The existing Docker publish workflow trigger was changed from automatic on push to manual.
Changes
| File(s) | Change Summary |
|---|---|
| .github/workflows/docker_build.yaml | Added a GitHub Actions workflow for automated version tagging and Docker image build/push. |
| .github/workflows/docker-publish.yml | Changed workflow trigger from automatic push on main branch to manual workflow_dispatch trigger. |
| VERSION | Added a new file containing the initial version number "0.0.1". |
Sequence Diagram(s)
sequenceDiagram
participant User
participant GitHub Actions
participant Repository
participant GHCR
User->>GitHub Actions: Trigger workflow_dispatch (with bump type/branch)
GitHub Actions->>Repository: Checkout code, fetch tags
GitHub Actions->>Repository: Determine latest version tag
GitHub Actions->>Repository: Create and push new version tag
GitHub Actions->>GitHub Actions: Pass new version to build job
GitHub Actions->>Repository: Checkout code for build
GitHub Actions->>GHCR: Login to registry
GitHub Actions->>GHCR: Build and push Docker image with new tag
Possibly related PRs
- MODSetter/SurfSense#122: Adds an automated Docker image build and publish workflow triggered on push to main, related to Docker image building and publishing but differs in trigger and version tagging approach.
Poem
A new workflow hops into view,
Tagging versions, building too!
Docker images, crisp and bright,
Pushed to GHCR, what a sight.
With "0.0.1" our journey's begun—
Automation magic, rabbit-style fun!
🐇✨
📜 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 92af9de7337bab7bef741f2644caffbb9d1d9a62 and 0c70064f2f95d3d85c53f9d231a485f5f11c2336.
📒 Files selected for processing (1)
.github/workflows/docker-publish.yml(1 hunks)
✅ Files skipped from review due to trivial changes (1)
- .github/workflows/docker-publish.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.
🪧 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
@coderabbitaiin a new review comment at the desired location with your query. Examples:@coderabbitai explain this code block.@coderabbitai modularize this function.
- PR comments: Tag
@coderabbitaiin 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 pauseto pause the reviews on a PR.@coderabbitai resumeto resume the paused reviews.@coderabbitai reviewto trigger an incremental review. This is useful when automatic reviews are disabled for the repository.@coderabbitai full reviewto do a full review from scratch and review all the files again.@coderabbitai summaryto regenerate the summary of the PR.@coderabbitai generate docstringsto generate docstrings for this PR.@coderabbitai generate sequence diagramto generate a sequence diagram of the changes in this PR.@coderabbitai resolveresolve all the CodeRabbit review comments.@coderabbitai configurationto show the current CodeRabbit configuration for the repository.@coderabbitai helpto get help.
Other keywords and placeholders
- Add
@coderabbitai ignoreanywhere in the PR description to prevent this PR from being reviewed. - Add
@coderabbitai summaryto generate the high-level summary at a specific location in the PR description. - Add
@coderabbitaianywhere in the PR title to generate the title automatically.
CodeRabbit Configuration File (.coderabbit.yaml)
- You can programmatically configure CodeRabbit by adding a
.coderabbit.yamlfile 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 review
✅ Actions performed
Review triggered.
Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.