让GitLab CI/CD做什么
嵌入式软件开发领域高频使用的开发语言是C语言
,在大型项目开发中,我们往往会有格式审查、编译审查的需求。如果能借助GitLab
平台实现代码的格式和编译问题审查,将会大大提高合入代码的规范性,把控新代码对原有代码的影响,提高代码整体质量。
本文将手把手教学如何借助CI
帮我们做代码格式审查、编译审查。
GitLab CI/CD快速搭建
VS Code设置
-
将
VS Code
设置为保存时自动格式化。
-
在代码根目录下放置
.clang-format
和.clang-format-ignore
文件。
.clang-format
文件是代码格式化和格式检查的配置文件,可以从Clang-Format
官方网页下载到模板再根据自己的需求调整,语法详见链接。编辑好了.clang-format
这个文件,置于代码根目录,用VS Code
编辑完代码后执行保存操作,保存的文件将自动按这个文件的格式规范来格式化代码。.clang-format-ignore
文件是用于配置在CI
中忽略代码格式检查的文件或文件夹。
GitLab 配置
前提:你已经在GitLab
有代码仓库,并且你是仓库的Owner
或Maintainer
身份。
如何让GitLab CI/CD为我们做代码格式的审查和编译审查呢,总结起来就五点:
- 仓库根目录配置
.gitlab-ci.yml
文件; - 仓库中配置代码审查的脚本、
clang-format
格式审查工具和编译脚本; - 配置一个用于编译的
MDK
工程; - 为
GitLab
公共仓库配置一个Runner