fix: enhance docker build CI pipeline, update docker ports, docs & new documents UI#866
Conversation
… job execution and integrating Docker metadata action for improved tagging and manifest creation
…and improve tagging logic for better handling of version tags
… formatting and clarity
…nd eliminate unnecessary exclusions
…and improve local development environment
…ity and consistency in local development environment
…ion options for improved user guidance
|
@AnishSarkar22 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. |
![recurseml[bot]](https://avatars.githubusercontent.com/in/1054195?s=60&v=4){kind=small}
There was a problem hiding this comment.
Review by RecurseML
🔍 Review performed on 248d050..609086e
✨ No bugs found, your code is sparkling clean
✅ Files analyzed, no issues (29)
• .dockerignore
• .github/workflows/docker_build.yaml
• docker/.env.example
• docker/docker-compose.dev.yml
• docker/docker-compose.yml
• docker/scripts/install.ps1
• docker/scripts/install.sh
• surfsense_web/app/sitemap.ts
• surfsense_web/content/docs/connectors/airtable.mdx
• surfsense_web/content/docs/connectors/clickup.mdx
• surfsense_web/content/docs/connectors/confluence.mdx
• surfsense_web/content/docs/connectors/discord.mdx
• surfsense_web/content/docs/connectors/gmail.mdx
• surfsense_web/content/docs/connectors/google-calendar.mdx
• surfsense_web/content/docs/connectors/google-drive.mdx
• surfsense_web/content/docs/connectors/jira.mdx
• surfsense_web/content/docs/connectors/linear.mdx
• surfsense_web/content/docs/connectors/microsoft-teams.mdx
• surfsense_web/content/docs/connectors/notion.mdx
• surfsense_web/content/docs/connectors/slack.mdx
• surfsense_web/content/docs/docker-installation.mdx
• surfsense_web/content/docs/docker-installation/dev-compose.mdx
• surfsense_web/content/docs/docker-installation/docker-compose.mdx
• surfsense_web/content/docs/docker-installation/install-script.mdx
• surfsense_web/content/docs/docker-installation/meta.json
• surfsense_web/content/docs/docker-installation/updating.mdx
• surfsense_web/content/docs/how-to/electric-sql.mdx
• surfsense_web/content/docs/how-to/meta.json
• surfsense_web/content/docs/installation.mdx
⏭️ Files skipped (1)
| Locations |
|---|
surfsense_web/content/docs/docker-installation/migrate-from-allinone.mdx |
…w index page and dedicated prerequisites section
…r improved community guidelines visibility
…y and user navigation
AnishSarkar22
changed the title
There was a problem hiding this comment.
Review by RecurseML
🔍 Review performed on 609086e..847564a
✨ No bugs found, your code is sparkling clean
✅ Files analyzed, no issues (10)
• surfsense_web/app/layout.config.tsx
• surfsense_web/app/sitemap.ts
• surfsense_web/content/docs/code-of-conduct.mdx
• surfsense_web/content/docs/docker-installation/dev-compose.mdx
• surfsense_web/content/docs/docker-installation/install-script.mdx
• surfsense_web/content/docs/docker-installation/migrate-from-allinone.mdx
• surfsense_web/content/docs/how-to/meta.json
• surfsense_web/content/docs/index.mdx
• surfsense_web/content/docs/meta.json
• surfsense_web/content/docs/prerequisites.mdx
…increase initial page size in use-documents hook
…ality; enhance LayoutDataProvider and LayoutShell to support new state management
…ine comment panel styling for improved responsiveness
…change from 480px to 380px in both docked and mobile views
…ce clarity and accessibility
…tarGroup component for better UI representation
…ce Popover with DropdownMenu for improved user experience
…management and connector integration; replace Cable icon with Unplug for better clarity
…gement to improve UI interactions
…DataProvider; enhance DropdownMenu in ComposerAction with separator for improved UI clarity
…e GitHub stars badge with particle effects for improved visual feedback
…integration and user engagement; update SidebarSlideOutPanel to conditionally render backdrop overlay based on mobile view
…te UI components for improved layout and user experience
…nsistency across connector forms
…ight and enable rich colors
…urces and Report; update report panel handling in dashboard chat page for improved user experience
… width adjustments; refactor ReportPanelContent to streamline loading state handling
…ges; implement version tagging and multi-platform support for backend and web services
…mations and layout handling; integrate motion effects for smoother transitions
…r components; adjust sidebar behavior based on device type and improve right panel handling
AnishSarkar22
changed the title
2 participants
Description
tag_release(only on default branch / manual dispatch),build(runs even when tagging is skipped), andcreate_manifest(runs as long as build succeeds) — enabling the workflow to build images for non-default branches likedev. Added null-safety for version tag computation, guarded version-based Docker tags withenableconditions to prevent empty tags, and introduced a newtype=sha,prefix=git-tag so every build is traceable to its exact commit. The workflow usesdocker buildxfor multi-platform image builds (linux/amd64, linux/arm64) and manifest creation.3929, backend uses8929, electric uses5929by default.Motivation and Context
FIX #
Screenshots
API Changes
Change Type
Testing Performed
Checklist
High-level PR Summary
This PR updates the default Docker ports for SurfSense to avoid conflicts with other services. The frontend now uses port
3929(previously3000), backend uses8929(previously8000), and Electric SQL uses5929(previously5133). The documentation has been reorganized into separate pages under a newdocker-installationsection, splitting the single Docker installation guide into dedicated pages for the install script, Docker Compose setup, updating, and development compose. All connector documentation and install scripts have been updated to reference the new port numbers and documentation structure.⏱️ Estimated Review Time: 30-90 minutes
💡 Review Order Suggestion
docker/.env.exampledocker/docker-compose.ymldocker/docker-compose.dev.ymldocker/scripts/install.shdocker/scripts/install.ps1surfsense_web/content/docs/docker-installation/install-script.mdxsurfsense_web/content/docs/docker-installation/docker-compose.mdxsurfsense_web/content/docs/docker-installation/updating.mdxsurfsense_web/content/docs/docker-installation/dev-compose.mdxsurfsense_web/content/docs/docker-installation/meta.jsonsurfsense_web/content/docs/docker-installation/migrate-from-allinone.mdxsurfsense_web/content/docs/how-to/electric-sql.mdxsurfsense_web/content/docs/how-to/meta.jsonsurfsense_web/content/docs/installation.mdxsurfsense_web/app/sitemap.tssurfsense_web/content/docs/connectors/airtable.mdxsurfsense_web/content/docs/connectors/clickup.mdxsurfsense_web/content/docs/connectors/confluence.mdxsurfsense_web/content/docs/connectors/discord.mdxsurfsense_web/content/docs/connectors/gmail.mdxsurfsense_web/content/docs/connectors/google-calendar.mdxsurfsense_web/content/docs/connectors/google-drive.mdxsurfsense_web/content/docs/connectors/jira.mdxsurfsense_web/content/docs/connectors/linear.mdxsurfsense_web/content/docs/connectors/microsoft-teams.mdxsurfsense_web/content/docs/connectors/notion.mdxsurfsense_web/content/docs/connectors/slack.mdx.dockerignore.github/workflows/docker_build.yaml.dockerignore.github/workflows/docker_build.yaml