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 Script。 IDE 会将这些代码片段视为功能完整的 Shell 脚本。 您可以编辑 Shell 脚本片段,对其进行解释,并享受语言特定功能,如语法高亮和代码补全。您可以使用配置文件中注入部分的 switch shell 脚本注入 意图操作来禁用此行为。 请注意,切换 Shell 脚本注入的开关会影响整个项目。

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