feat(db): migrate to timestamp-based migrations to prevent PR conflicts #3414
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This change addresses the issue of migration file conflicts when multiple contributors create migrations in parallel. The previous sequential numbering system (0001_, 0002_, etc.) caused conflicts when two PRs both added migrations. Changes: - Convert all 134 existing migrations from index format (0000_) to timestamp format (YYYYMMDDHHmmss_) based on their original creation timestamps - Add `prefix: 'timestamp'` to drizzle.config.ts for future migrations - Add `migration:new` script that enforces descriptive migration names - Add `migration:convert` script for the one-time conversion - Add MIGRATIONS.md documentation for contributors - Remove orphaned migration file (0057_damp_prism.sql) The timestamp format prevents conflicts because each migration gets a unique prefix based on when it was created (e.g., 20240627143052_add-feature.sql). New workflow for contributors: pnpm run migration:new add-user-preferences This generates migrations with meaningful names and timestamp prefixes, eliminating merge conflicts and improving migration readability.
Contributor
Author
|
@Siumauricio Hi, I have created this PR to allow for better management of migrations to allow PRs to be easier to merge in regards to migrations. |
…ix-migration-management-80CA9
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What is this PR about?
This change addresses the issue of migration file conflicts when multiple contributors create migrations in parallel. The previous sequential numbering system (0001_, 0002_, etc.) caused conflicts when two PRs both added migrations.
Changes:
prefix: 'timestamp'to drizzle.config.ts for future migrationsmigration:newscript that enforces descriptive migration namesmigration:convertscript for the one-time conversionThe timestamp format prevents conflicts because each migration gets a unique prefix based on when it was created (e.g., 20240627143052_add-feature.sql).
New workflow for contributors:
pnpm run migration:new add-user-preferences
This generates migrations with meaningful names and timestamp prefixes, eliminating merge conflicts and improving migration readability.
Checklist
Before submitting this PR, please make sure that:
canarybranch.Issues related (if applicable)
Screenshots (if applicable)