我应该在.gitignore文件中添加Django迁移文件吗?

由于迁移冲突,我最近遇到了很多git问题,我想知道是否应该将迁移文件标记为忽略。

如果是这样,我将如何去添加所有的迁移,我在我的应用程序,并将它们添加到.gitignore文件?


当前回答

简短的回答 我建议在回购中排除迁移。代码合并后,只需运行./manage.py makemigrations,就可以完成所有设置。

长回答 我认为您不应该将迁移文件放入repo。它会破坏在别人的开发环境和其他刺激和阶段环境中的迁移状态。(举例请参考Sugar Tang的评论)。

在我看来,Django迁移的目的是找到以前的模型状态和新的模型状态之间的差距,然后序列化这个差距。如果你的模型在代码合并后发生了变化,你可以简单地做makemigrationations来找出差距。当您可以自动且无错误地完成相同的迁移时,为什么还要手动且仔细地合并其他迁移呢?Django文档说,

他们*(迁移)*被设计成大部分是自动的

; 请保持这样。要手动合并迁移,您必须完全理解其他人更改了什么以及更改的依赖性。这是很大的开销,而且很容易出错。因此跟踪模型文件就足够了。

这是关于工作流的一个很好的主题。我愿意接受其他选择。

其他回答

您可以遵循以下流程。

您可以在本地运行makemigrations,这将创建迁移文件。将这个新的迁移文件提交到repo。

在我看来,你根本不应该在生产中进行大规模移民。您可以在生产环境中运行migrate,您将看到从本地提交的迁移文件应用了迁移。这样可以避免所有的冲突。

在LOCAL ENV中,要创建迁移文件,

python manage.py makemigrations 
python manage.py migrate

现在提交这些新创建的文件,如下所示。

git add app/migrations/...
git commit -m 'add migration files' app/migrations/...

在PRODUCTION ENV中,只执行以下命令。

python manage.py migrate

我无法想象为什么会出现冲突,除非您正在以某种方式编辑迁移?这通常会以糟糕的结果结束——如果有人错过了一些中间提交,那么他们将无法从正确的版本升级,并且他们的数据库副本将被损坏。

我遵循的过程非常简单——无论何时你改变了一个应用程序的模型,你也提交了一个迁移,然后这个迁移不会改变——如果你需要模型中有一些不同的东西,那么你就改变模型,并在你的改变的同时提交一个新的迁移。

在未开发的项目中,当你发布时,你通常可以删除迁移,然后用0001_迁移从头开始,但如果你有生产代码,那么你不能(尽管你可以把迁移压缩成一个)。

您应该将迁移视为数据库模式的版本控制系统。Makemigrations负责将模型更改打包到单独的迁移文件中(类似于提交),migrate负责将这些文件应用到数据库中。

每个应用程序的迁移文件都存在于该应用程序内部的“migrations”目录中,并被设计为提交并作为其代码库的一部分分发。您应该在您的开发机器上进行一次迁移,然后在您同事的机器、登台机器以及最终的生产机器上运行相同的迁移。

黄金法则:在开发中只做一次,然后移植到所有开发中

通常使用的解决方案是,在将任何内容合并到master之前,开发人员必须提取任何远程更改。如果在迁移版本中存在冲突,他应该将本地迁移(远程迁移已经由其他开发人员运行,并且可能已经在生产中运行)重命名为N+1。

在开发过程中,不提交迁移是可以的(但是不要添加忽略,不要添加它们)。但是一旦进入生产环境,您将需要它们来保持模式与模型更改同步。

然后需要编辑该文件,并将依赖项更改为最新的远程版本。

这适用于Django迁移,以及其他类似的应用程序(sqlalchemy+alembic, RoR等)。

DR:提交迁移,解决迁移冲突,调整git工作流程。

感觉你需要调整你的git工作流程,而不是忽略冲突。

理想情况下,每个新特性都在不同的分支中开发,并与拉请求合并。

如果有冲突,pr就不能合并,因此需要合并他的特性的人需要解决冲突,包括迁移。这可能需要不同团队之间的协调。

提交迁移文件是很重要的!如果出现冲突,Django甚至可以帮你解决这些冲突;)