GitLab CI/CD
PyCharm 能识别并为 .gitlab-ci.yml 文件提供代码辅助,您可以在其中为 GitLab CI/CD 流水线定义指令。 有关更多详细信息,请参阅 GitLab 文档。
功能
支持以下功能:
PyCharm 为 GitLab CI/CD 配置文件的所有组成部分提供语法高亮。 您可以为配置的不同部分自定义配色方案:
配置文件的 YAML 结构:
PyCharm 可实时帮助您检测 GitLab CI/CD 配置文件中的配置问题。 包括作业重复使用、未定义的作业以及未定义的阶段。
获取流水线配置语法、关键字和 CI/CD 变量的补全建议。

在 CI/CD 配置文件中,在
stage与job的声明和用法之间快速导航。将鼠标悬停在符号上,或使用 文档 工具窗口(Ctrl+Q )查看快速文档,其中包含指向 GitLab CI 官方参考的链接。

直接在配置文件中搜索
stage和job符号的用法。您可以应用重命名重构(Shift+F6 ),更改
stage和job符号在声明和用法中的名称。检测 Shell 脚本语言注入
PyCharm 会自动检测配置文件的
before_script、script和after_script块中的 Shell 脚本注入,并将其标记为 注入语言:Shell 脚本。 IDE 会将这些代码片段视为功能完备的 Shell 脚本。 您可以编辑 Shell 脚本片段、对其进行解释,并受益于特定语言功能,如语法高亮和代码补全。您可以在配置文件的注入部分使用 switch shell 脚本注入 意图操作来禁用此行为。 请注意,启用或禁用 Shell 脚本注入会影响整个项目。

疑难解答
缺少代码辅助功能
为确保对 GitLab CI/CD 的完整支持,请检查您的 .gitlab-ci.yml 文件是否使用了正确的 JSON 架构。
PyCharm 会自动加载一组常用架构,其中包括 GitLab 的 CI 架构(通常名为 gitlab-ci)。
如果代码补全、检查或导航等功能缺失或未如预期工作,则问题可能与 JSON 架构配置有关。
配置 JSON 架构
在编辑器中打开 .gitlab-ci.yml 文件,并检查右下角的 JSON 架构小部件。 请确保已选择
gitlab-ci。
如果未列出该架构:
从 https://gitlab.com/gitlab-org/gitlab/-/raw/master/app/assets/javascripts/editor/schema/ci.json 手动下载。
在 PyCharm 中,转到 ,并 添加自定义 JSON 架构映射。
使用 JSON 架构小部件将添加的架构分配给您的 .gitlab-ci.yml 文件。