开发R包时.gitignore与.Rbuildignore的区别及配置示例

核心区别 #

这两个文件的作用范围完全不同：

• .gitignore 是Git版本控制工具的配置文件，它告诉Git哪些文件不需要纳入版本追踪，不会被推送到GitHub仓库。
• .Rbuildignore 是**R包构建工具（如devtools::build()、R CMD build）**的配置文件，它告诉R在生成可安装的包文件（tar.gz）时，忽略哪些文件——这些文件可能仍然被Git追踪（保存在仓库里），只是不会出现在最终的安装包中。

.gitignore：控制Git追踪范围 #

应该包含的内容 #

主要是那些只在本地开发时产生、不需要共享到仓库的文件：

• R会话生成的临时缓存文件
• 编辑器/IDE生成的配置或临时文件
• 包构建后生成的最终产物（比如tar包、检查报告文件夹）
• 本地敏感信息、私人配置文件
• 测试用的临时数据、日志文件

示例内容 #

# R本地临时文件
.Rhistory
.RData
.Ruserdata
.Rproj.user/

# 包构建产物
*.tar.gz
*.Rcheck/
vignettes/*.html
vignettes/*.pdf

# 编辑器/IDE相关
.vscode/
.idea/
*.swp
*.swo

# 敏感/本地专属文件
.env
private/
temp_data/

.Rbuildignore：控制R包构建范围 #

应该包含的内容 #

主要是那些属于仓库开发资源、但不需要包含在最终安装包里的文件：

• Git相关的配置文件（用户安装包不需要.gitignore）
• 开发阶段的辅助脚本、笔记、临时测试代码
• CI/CD配置文件（比如GitHub Actions的工作流文件）
• 文档的中间生成产物（比如从Rmd渲染来的README.md）
• 原始数据文件（如果包只提供处理后的数据集）

示例内容 #

# Git相关文件
^\.gitignore$
^\.git/$

# 开发辅助目录
^dev/
^notes/
^sandbox/

# CI配置
^\.github/$

# 文档中间产物
^README\.md$

# 临时测试代码
^tests/testthat/temp_.*\.R$

补充说明 #

部分文件可能同时出现在两个文件中，比如.Rproj.user/——它既不需要Git追踪，也不需要包含在安装包里。但也有很多文件只需要在其中一个里：比如dev/目录通常需要Git追踪（保留开发脚本），但构建包时要忽略，所以只放进.Rbuildignore。

内容的提问来源于stack exchange，提问作者MTMT