从Doodba Scaffolding迁移到Doodba Copier Template的技术指南

前言

本文将详细介绍如何从传统的Doodba Scaffolding迁移到新一代的Doodba Copier Template。对于使用Doodba框架进行Odoo开发的团队来说，这是一次重要的技术升级。

为什么需要迁移

传统的Doodba Scaffolding存在几个明显的技术痛点：

1. 版本控制混乱：项目git历史中混杂了大量上游模板的提交记录
2. 缺乏动态配置能力：静态模板无法根据Python版本等条件进行智能调整
3. 升级困难：修改默认值可能导致生产环境问题
4. 文档维护困难：README等内容需要在多个项目间重复维护

Copier模板引擎完美解决了这些问题，提供了更强大、更灵活的解决方案。

迁移准备步骤

1. 更新到最新Scaffolding版本

cd ~/项目路径
git remote add scaffolding 原始模板仓库地址
git pull scaffolding master

如果出现冲突，需要手动解决：

git mergetool  # 或手动解决冲突
git add .
git merge --continue

完成后移除不再需要的远程仓库：

git remote rm scaffolding

2. 调整文件缩进格式

新模板使用2空格缩进替代原来的4空格，建议提前调整：

sed -i 's/    /  /g' .vscode/*.{json,code-snippets} *.yaml odoo/custom/src/*.yaml
git commit -am '[DCK] 将YAML和JSON文件缩进改为2空格'

执行Copier迁移

1. 安装必要工具

确保已安装Copier和所有依赖项。

2. 运行Copier更新

copier update

系统会询问一系列配置问题，必须确保回答与现有配置一致，否则可能导致升级问题。

3. 冲突解决

迁移过程中可能会产生三类冲突：

1. .rej文件：包含Copier无法自动解决的冲突，需要手动检查
2. git diff差异：需要仔细审查所有变更
3. 格式调整：使用pre-commit工具统一代码风格

推荐使用图形化工具查看差异：

git difftool

4. 提交变更

git add .
git commit -am '[DCK] 从doodba-scaffolding升级到doodba-copier-template'
pre-commit run -a  # 运行代码格式化
git commit -am '[IMP] 首次执行pre-commit'

迁移后的主要变化

配置变更

1. 环境变量：

   • BACKUP_S3_BUCKET → BACKUP_DST（更通用的备份目标配置）

2. Traefik标签：

   • traefik.alt → traefik.alt-0（支持多备用域名）

3. 新增文件：

   • .copier-answers.yml：记录所有配置回答，切勿手动修改
   • .pre-commit-config.yaml：强大的代码格式化配置
   • tasks.py：提供便捷的invoke任务

移除的内容

1. 目录/文件：

   • .vscode/doodba/
   • .vscode/doodbasetup.py
   • .travis.yml（如需可手动恢复）

2. VSCode任务：被invoke命令替代

新功能亮点

1. Invoke任务系统

# 初始化开发环境
invoke develop

# 下载git代码
invoke git-aggregate

# 查看所有可用任务
invoke --list

2. 增强的代码质量工具

集成了多种linter和formatter，通过pre-commit自动执行，显著提升代码质量。

3. VSCode增强

新增推荐的扩展程序，提供更完善的开发体验。

注意事项

1. XML文件空白字符：pre-commit可能会修改XML文件格式，需特别注意
2. 许可证变更：如果未在copier update中指定，LICENSE文件可能被更新
3. 多备用域名：现在支持配置多个备用域名

结语

迁移到Doodba Copier Template虽然需要一些手动调整，但带来的好处是显而易见的：更清晰的版本控制、更灵活的配置方式、更强大的开发工具链。建议开发团队尽快完成迁移，以获得最佳的开发体验。