GitHub Actions

GitHub Actions 是一款持续集成与持续交付（CI/CD）平台，可让您自动化构建、测试和部署流水线。 PyCharm 可识别 GitHub YAML 文件，并为其提供编码辅助。 这包括您的仓库中 .github/workflows 目录下的工作流文件，以及 .github/actions 目录下的操作文件。 有关更多信息，请参阅 GitHub Actions 文档。

在处理 GitHub 文件时，PyCharm 支持以下功能：

• 语法高亮显示

  PyCharm 为文件的 YAML 结构提供语法高亮显示。 您可以在 设置 | 编辑器 | 配色方案 | YAML 中自定义配色方案。

• 检查

  您可以在 GitHub 文件中检测循环作业依赖、无效的参数或标准库函数调用、未定义的操作或文件引用、未定义的作业依赖以及未定义的参数。

  

  您可以在 设置 对话框（Ctrl+Alt+S ）的 编辑器 | 检查 | GitHub 操作 下管理 GitHub Actions 检查。

• 代码补全

  PyCharm 提供广泛的补全支持，帮助您更快地编写 GitHub 工作流和操作。 包括：

  • 针对各种 GitHub Actions 上下文的补全，包括 github.*、 env.*、 steps.* 和 inputs.*。 这将简化编写复杂工作流脚本的过程，并减少查找特定上下文语法和参数所花费的时间。

  • 针对 needs 和 runs-on 属性的作业依赖补全。

  • YAML 结构建议。

  • 为本地操作以及在 GitHub 上由 actions 组织发布的操作提供参数、名称和版本的自动补全。

  • 针对计划的工作流提供带有验证和补全的 CRON 表达式支持。

    

  • 提供 Docker 映像和标签建议，以将 Docker 容器集成到您的操作中。

  • JavaScript 文件路径补全。

  • 在 action.yml 中提供品牌支持，允许您指定图标和颜色，以便在 GitHub Marketplace 和工作流中直观地区分您的操作。

• 代码导航

  您可以在 GitHub Actions 文件中快速在符号的声明与用法之间导航。

• 快速文档

  将鼠标悬停在符号上，或使用 文档 工具窗口（Ctrl+Q ）查看快速文档。