R包发布至CRAN后CRAN-SUBMISSION文件应如何处理
CRAN-SUBMISSION 文件的设计作用
这个文件是devtools::release()提交流程自动生成的临时状态标记文件,核心用途有两点:
- 留存本次CRAN提交的核心校验信息:包括提交的包版本号、提交UTC时间戳、对应代码版本的Git SHA值,避免提交过程中本地代码意外改动、版本号错配,导致最终传到CRAN的代码和你预期提交的版本不一致
- 作为提交流程的断点标识:如果提交中途出现网络中断、流程意外终止的情况,下次重新执行
devtools::release()时,工具会读取这个文件判断是否存在未完成的同版本提交,避免重复提交相同版本增加CRAN审核团队的不必要工作量
旧版本提示移除的原因
devtools 2.4.0之前的版本,确实会在生成的CRAN-SUBMISSION文件末尾标注“版本成功发布到CRAN后即可删除此文件”的提示,后续版本移除这个提示主要是两个原因:
- 新版devtools已经加入了自动清理逻辑:当工具检测到对应版本已经成功在CRAN上线、整个提交流程闭环后,会自动删除本地的CRAN-SUBMISSION文件,不需要用户手动操作,手动删除的提示失去了存在的意义
- 旧提示反而会误导部分用户,让用户以为这个文件是需要手动维护的项目文件,反而长期留存造成仓库冗余,移除提示同时配套自动清理逻辑,能减少用户不必要的决策成本
Git 仓库的处理建议
这个文件完全不需要纳入Git版本追踪:
- 它是纯本地生成的临时状态文件,不同开发者、不同次提交生成的时间戳、SHA值都不相同,追踪它只会产生无意义的合并冲突,本身也不包含任何需要跨设备同步、长期留存的项目配置信息
- 最合理的处理方式是直接将
CRAN-SUBMISSION加入项目的.gitignore忽略列表。devtools已经自动将它加入.Rbuildignore,所以这个文件永远不会被打包进发往CRAN的源码包,不会造成提交污染,不需要每次手动删除,配置好忽略规则即可 - 如果之前误将这个文件提交到了Git仓库,直接从版本追踪列表中移除即可,不会对包开发、后续CRAN提交流程造成任何负面影响
内容的提问来源于stack exchange,提问作者stragu
相关产品推荐
相关产品推荐

