WebStorm 2025.3 Help

GitLab CI/CD

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

功能

支持以下功能:

  • 语法高亮

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

  • 检查

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

  • 代码补全

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

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

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

  • 快速文档

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

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

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

  • 重命名重构

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

  • 检测 Shell 脚本语言注入

    WebStorm 会在您的配置文件的 before_scriptscriptafter_script 块中自动检测 Shell 脚本语言注入,并将其标记为 注入语言:Shell 脚本。 IDE 会将这些代码片段视为功能完备的 Shell 脚本。 您可以编辑 Shell 脚本片段、对其进行解释,并利用特定语言的功能,如语法高亮显示和代码补全。

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

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

故障排查

缺少编码辅助功能

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

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

如果代码补全、检查或导航等功能缺失或未按预期工作,问题可能与 JSON 架构配置有关。

配置 JSON 架构

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