JetBrains Rider 2025.3 Help

GitLab CI/CD

JetBrains Rider 可识别并为 .gitlab-ci.yml 文件提供编码辅助,您可以在其中为 GitLab CI/CD 流水线定义指令。 有关更多详情,请参阅 GitLab 文档

启用 GitLab 插件

此功能依赖于 GitLab 插件,该插件默认在 JetBrains Rider 中捆绑并启用。 如果相关功能不可用,请确保您未禁用该插件。

  1. 按下 Ctrl+Alt+S 打开设置,然后选择 插件

  2. 打开 已安装 选项卡,找到 GitLab 插件,然后选中插件名称旁的复选框。

功能

支持以下功能:

  • 语法高亮

    JetBrains Rider 为 GitLab CI/CD 配置文件中的所有组件提供语法高亮显示。 您可以为配置的不同部分自定义配色方案:

    • 配置文件的 YAML 结构:

      设置/首选项 | 编辑器 | 配色方案 | YAML

    • CI/CD 变量表达式

      设置/首选项 | 编辑器 | 配色方案 | GitLab CI 表达式

    • Shell 脚本注入

      设置/首选项 | 编辑器 | 配色方案 | Shell 脚本

  • 检查

    JetBrains Rider 可帮助您实时检测 GitLab CI/CD 配置文件中的配置问题。 包括作业重复使用、未定义的作业和未定义的阶段。

  • 代码补全

    获取对流水线配置语法、关键字和 CI/CD 变量的补全建议。

    GitLab CI/CD 流水线配置语法的代码补全
  • 代码导航

    在 CI/CD 配置文件中快速在 stagejob 的声明与用法之间导航。

  • 快速文档

    将鼠标悬停在符号上,或使用 文档 工具窗口(Ctrl+Q )查看快速文档,其中包含指向 GitLab CI 官方参考文档的链接。

    GitLab CI 配置的快速文档
  • 查找用法

    直接在配置文件中搜索对 stagejob 符号的用法。

  • “重命名”重构

    您可以通过应用“重命名”重构(Shift+F6 )更改声明和用法中 stagejob 符号的名称。

  • 检测 Shell 脚本语言注入

    JetBrains Rider 会自动检测配置文件中的 before_scriptscriptafter_script 块中的 Shell 脚本注入,并将其标记为 注入语言:Shell 脚本。 IDE 会将这些代码段视为功能完整的 Shell 脚本。 您可以编辑 Shell 脚本片段,解释其含义,并享受针对语言的功能,如语法高亮显示和代码补全。

    您可以在配置文件中注入部分使用 switch shell 脚本注入 意图操作以禁用此行为。 请注意,切换 Shell 脚本注入的启用状态会影响整个项目。

    GitLab CI 配置文件中的 Shell 脚本注入

故障排除

缺失的编码辅助功能

为确保全面支持 GitLab CI/CD,请检查您的 .gitlab-ci.yml 文件是否使用了正确的 JSON 架构。

JetBrains Rider 会自动加载一组常用架构,包括 GitLab 的 CI 架构(通常命名为 gitlab-ci)。

如果缺少代码补全、检查或导航等功能,或这些功能未按预期工作,可能是由于 JSON 架构配置问题。

配置 JSON 架构

最后修改日期: 2025年 12月 5日