JetBrains Rider 2025.2 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 变量的补全建议。

    流水线配置语法的代码补全
  • 代码导航

    在 CI/CD 配置文件中快速在 阶段作业 的声明和用法之间导航。

  • 快速文档

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

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

    直接在配置文件中搜索 阶段作业 符号的用法。

  • 重命名重构

    可以通过应用重命名重构(Shift+F6 )更改声明和用法中 阶段作业 符号的名称。

  • Shell 脚本语言注入的检测

    JetBrains Rider 会自动检测配置文件中的 before_scriptscriptafter_script 块中的 Shell 脚本注入,并将其标记为 注入语言:Shell Script。 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年 9月 26日