gitlab-ci.yml
.gitlab-ci.yml
文件的位置
该文件应放置在 GitLab 项目的代码仓库的根目录 下,具体说明如下:
-
存储库根目录
.gitlab-ci.yml
是 GitLab 持续集成(CI)的配置文件,需直接放在项目的代码仓库的根目录(与.git
目录同级)[1][2][3][5]。- 例如:
my_project/ ├── .gitlab-ci.yml # 正确位置 ├── src/ └── README.md
-
GitLab 系统目录无关
- 该文件属于项目代码库,与 GitLab 服务器端的文件系统目录(如
/etc/gitlab
或/var/opt/gitlab
)无关。它通过 Git 仓库管理,随代码版本控制[3][7]。
- 该文件属于项目代码库,与 GitLab 服务器端的文件系统目录(如
为何放在根目录?
- GitLab 的 CI 系统会在每次代码推送时自动检测仓库根目录下的
.gitlab-ci.yml
文件,并根据其内容触发 CI 流程[1][6]。 - 若文件不在根目录,CI 将无法识别配置,导致流水线不执行[3][7]。
如何验证文件位置?
-
在本地仓库检查
- 确保
.gitlab-ci.yml
文件位于克隆的仓库根目录(与.git
目录同级)。 - 示例命令:
ls -a # 查看根目录下是否存在 .gitlab-ci.yml
- 确保
-
在 GitLab Web 界面操作
- 进入项目主页 > 文件浏览器,确保
.gitlab-ci.yml
文件在项目根目录(路径为/
),而非子目录[5][7]。
- 进入项目主页 > 文件浏览器,确保
其他注意事项
- 文件命名:必须命名为
.gitlab-ci.yml
(大小写敏感),不可自定义文件名[1][8]。 - YAML 语法:文件需符合 YAML 格式,缩进使用空格(避免 Tab 键),可通过 GitLab 的 CI Lint 工具校验语法[3][7]。
- 权限问题:确保文件对 CI Runner 可见(无
.gitignore
忽略或权限限制)[3]。
若有其他问题(如配置错误或 Runner 问题),可进一步排查具体配置或日志。