GitHub Actions for R 项目教程

GitHub Actions for R 项目教程

actions GitHub Actions for the R community 项目地址: https://gitcode.com/gh_mirrors/act/actions

1. 项目目录结构及介绍

r-lib/actions
├── clusterfuzzlite
├── github
├── RR
├── check-r-package
├── examples
├── pr-fetch
├── pr-push
├── setup-manifest
├── setup-pandoc
├── setup-r-dependencies
├── setup-r
├── setup-renv
├── setup-tinytex
├── src
├── tests
├── vignettes
├── Rbuildignore
├── gitignore
├── CITATION.cff
├── DESCRIPTION
├── LICENSE
├── Makefile
├── NAMESPACE
├── NEWS.md
├── README.md
├── _pkgdown.yml
└── actions.Rproj

目录结构介绍

• clusterfuzzlite: 包含与 fuzzing 相关的文件。
• github: 包含与 GitHub 相关的配置和脚本。
• RR: 包含与 R 相关的配置和脚本。
• check-r-package: 包含用于检查 R 包的配置和脚本。
• examples: 包含示例工作流文件。
• pr-fetch: 包含用于获取 PR 更改的配置和脚本。
• pr-push: 包含用于推送 PR 更改的配置和脚本。
• setup-manifest: 包含用于设置 R 项目与 Posit Connect 清单文件的配置和脚本。
• setup-pandoc: 包含用于设置 Pandoc 的配置和脚本。
• setup-r-dependencies: 包含用于安装 DESCRIPTION 文件中声明的包的配置和脚本。
• setup-r: 包含用于设置 R 环境的配置和脚本。
• setup-renv: 包含用于从 renv 锁文件安装包的配置和脚本。
• setup-tinytex: 包含用于设置 LaTeX 与 tinytex 的配置和脚本。
• src: 包含项目的源代码。
• tests: 包含项目的测试文件。
• vignettes: 包含项目的 vignettes 文件。
• Rbuildignore: 包含 R 构建时忽略的文件列表。
• gitignore: 包含 Git 忽略的文件列表。
• CITATION.cff: 包含项目的引用信息。
• DESCRIPTION: 包含项目的描述信息。
• LICENSE: 包含项目的许可证信息。
• Makefile: 包含项目的 Makefile。
• NAMESPACE: 包含项目的命名空间信息。
• NEWS.md: 包含项目的更新日志。
• README.md: 包含项目的 README 文件。
• _pkgdown.yml: 包含项目的 pkgdown 配置文件。
• actions.Rproj: 项目的 RStudio 项目文件。

2. 项目启动文件介绍

actions.Rproj

actions.Rproj 是项目的 RStudio 项目文件。通过打开这个文件，可以在 RStudio 中启动项目，并自动加载项目的配置和环境。

3. 项目配置文件介绍

DESCRIPTION

DESCRIPTION 文件包含了项目的元数据，如包的名称、版本、依赖关系等。这个文件是 R 包开发中的核心配置文件之一。

LICENSE

LICENSE 文件包含了项目的许可证信息。该项目使用的是 CC0-1.0 许可证。

Makefile

Makefile 文件包含了项目的构建和测试命令。通过运行 make 命令，可以执行这些命令来构建和测试项目。

_pkgdown.yml

_pkgdown.yml 文件是 pkgdown 的配置文件，用于生成项目的文档网站。通过配置这个文件，可以自定义文档网站的外观和内容。

Rbuildignore

Rbuildignore 文件列出了在构建 R 包时需要忽略的文件和目录。这些文件和目录不会被打包到最终的 R 包中。

gitignore

gitignore 文件列出了在 Git 版本控制中需要忽略的文件和目录。这些文件和目录不会被 Git 跟踪。

actions GitHub Actions for the R community 项目地址: https://gitcode.com/gh_mirrors/act/actions