Skip to content

Database migration workflow guide #546

Closed

Description

@codebestia

Write apps/backend/docs/migrations.md covering the drizzle-kit workflow: editing src/db/schema.ts, running pnpm db:generate, reviewing the emitted SQL, and pnpm db:migrate. Explain the drizzle/ layout — the .sql files, meta/_journal.json, and the per-migration snapshots.

Acceptance criteria:

  • Explains that schema.ts is the source of truth and migrations are generated from it, never hand-written first
  • Documents meta/_journal.json as the file that decides which migrations actually run, and that a migration file not listed there is silently skipped
  • Documents the merge hazard concretely: parallel branches each generating a migration produce colliding prefixes and duplicated journal entries — this has already broken this repo's history once
  • Gives the recommended procedure for resolving a migration conflict during a merge
  • Notes that drizzle/meta/ is Prettier-ignored because it is generated output

Activity

  1. Deb-Auth commented on Aug 30, 2026

    @Deb-Auth

    @Deb-Auth has applied to work on this issue as part of the Stellar Wave Program's 8th wave.

    I'm interested in working on this issue. I'll carefully follow the project's guidelines and submit a tested, maintainable solution.

    ℹ️ Repo Maintainers: To accept this application, review their application or assign @Deb-Auth to this issue.

  2. drips-wave commented on Aug 30, 2026

    @drips-wave

    Congratulations, @Deb-Auth! 🎉 Your application was accepted by the repo's maintainers, and the issue is due on August 31, 2026.

    🧑‍💻 @Deb-Auth: Please resolve the issue such that the repo's maintainers have enough time to review your contribution before the due date. You'll earn Points for completing the issue on-time, which will make you eligible for a share of the Stellar Wave Program's reward pool.

    Warning

    When opening a PR, please link it to this issue to ensure it gets tracked accurately. Points are awarded when this issue is marked as completed by the maintainer.

    🤠 Repo maintainers: Please keep an eye on the contributor's progress and review their work before the due date. You can manage this issue, including adjusting its complexity and points, here.

    🌊 Happy Wave 🌊

  3. added a commit that references this issue on Aug 31, 2026
    5ed1162
  4. github-actions commented on Aug 31, 2026

    @github-actions

    Closed by #597, merged into dev.

  5. drips-wave commented on Aug 31, 2026

    @drips-wave

    This issue has been completed by @Deb-Auth as part of the Stellar Wave Program's 8th Wave 🥳

    😎 @Deb-Auth: You earned 200 Points for completing this issue! After the current Wave ends, you'll be eligible for a percentage of the Wave's reward pool based on the percentage of total points you've earned. Learn more here. You can also Leave a review to share your experience working on this issue.

    🧑‍💻 Repo maintainers: How'd the contributor do? Leave a review to share your experience working with them.

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

Metadata

Metadata

Assignees

Labels

Stellar WaveIssues in the Stellar wave programdatabasedocumentationImprovements or additions to documentationdx

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions