Skip to content

[4726] fix(docs): update sparse-checkout command to include DB-init SQL#4879

Open
Sanket2329 wants to merge 1 commit into
Agenta-AI:mainfrom
Sanket2329:fix/4726-self-host-db-init
Open

[4726] fix(docs): update sparse-checkout command to include DB-init SQL#4879
Sanket2329 wants to merge 1 commit into
Agenta-AI:mainfrom
Sanket2329:fix/4726-self-host-db-init

Conversation

@Sanket2329

@Sanket2329 Sanket2329 commented Jun 26, 2026

Copy link
Copy Markdown
Contributor

Summary

Resolves #4726. When following the self-hosting Quick Start or Remote Deployment guides verbatim, a brand-new OSS deploy comes up with no application databases because the docker-compose.gh.yml file bind-mounts api/oss/databases/postgres/init-db-oss.sql which lies outside the checked out hosting/docker-compose sparse cone.

This PR extends the git sparse-checkout commands in the quick-start and remote deployment documentation to also fetch the api/oss/databases/postgres and api/ee/databases/postgres directories, ensuring that database initialization SQL scripts are present on disk before running the containers.

Testing

Verified locally

  • Verified locally that running the sparse clone and checkout instructions verbatim successfully retrieves the DB-init script paths:
    git clone --depth 1 --filter=blob:none --sparse https://github.com/Agenta-AI/agenta
    cd agenta
    git sparse-checkout set hosting/docker-compose api/oss/databases/postgres api/ee/databases/postgres

@dosubot dosubot Bot added the size:XS This PR changes 0-9 lines, ignoring generated files. label Jun 26, 2026
@vercel

vercel Bot commented Jun 26, 2026

Copy link
Copy Markdown

@Sanket2329 is attempting to deploy a commit to the agenta projects Team on Vercel.

A member of the Team first needs to authorize it.

@dosubot dosubot Bot added the documentation Improvements or additions to documentation label Jun 26, 2026
@github-actions

github-actions Bot commented Jun 26, 2026

Copy link
Copy Markdown
Contributor

✅ Thanks @Sanket2329! This PR now meets the contribution requirements and has been reopened. A maintainer will review it soon.

@github-actions github-actions Bot added the incomplete-pr PR is missing required template sections or a demo recording label Jun 26, 2026
@github-actions github-actions Bot closed this Jun 26, 2026
@coderabbitai

coderabbitai Bot commented Jun 26, 2026

Copy link
Copy Markdown

Review Change Stack

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 0032ecc6-05ef-4c99-8acd-355e10bdcdfc

📥 Commits

Reviewing files that changed from the base of the PR and between b6fafc3 and 497f747.

📒 Files selected for processing (2)
  • docs/docs/self-host/01-quick-start.mdx
  • docs/docs/self-host/guides/01-deploy-remotely.mdx

Disabled knowledge base sources:

  • Linear integration is disabled

You can enable these sources in your CodeRabbit configuration.


📝 Walkthrough

Summary by CodeRabbit

  • Documentation
    • Updated self-hosting setup instructions to include the additional repository paths needed for Docker Compose and PostgreSQL components.
    • Improved remote deployment guidance so the code checkout step now retrieves all required database-related assets.

Walkthrough

Both self-host setup docs now expand the git sparse-checkout path list to include Docker Compose assets and PostgreSQL database directories for OSS and EE.

Changes

Self-host sparse-checkout docs

Layer / File(s) Summary
Expand sparse-checkout path lists
docs/docs/self-host/01-quick-start.mdx, docs/docs/self-host/guides/01-deploy-remotely.mdx
Both guides update the git sparse-checkout set command to fetch Docker Compose files and Postgres database directories for OSS and EE.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Possibly related issues

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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

Comment @coderabbitai help to get the list of available commands.

@github-actions github-actions Bot removed the incomplete-pr PR is missing required template sections or a demo recording label Jun 26, 2026
@github-actions github-actions Bot reopened this Jun 26, 2026
@Sanket2329

Copy link
Copy Markdown
Contributor Author

Hi @jp-agenta, @mmabrouk – this pull request is ready for review. It implements the agreed Option A (extending the sparse-checkout command to include the database initialization SQL paths) to resolve issue #4726, and has been successfully verified locally.

Could you please take a look when you have a moment? Thank you!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation size:XS This PR changes 0-9 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

(bug) Self-hosting quick-start: documented sparse-checkout omits the DB-init SQL, so a fresh OSS deploy never creates its databases

1 participant