GitHub Actions

GitHub Actions 是一个持续集成与持续交付（CI/CD）平台，可帮助您自动化构建、测试和部署流程。 PyCharm 可识别 GitHub YAML 文件，并为其提供编码支持。 这包括存储在存储库的 .github/workflows 目录中的 workflow 文件和存储在 .github/actions 目录中的 action 文件。 有关更多信息，请参阅 GitHub Actions 文档。

PyCharm 支持以下与 GitHub 文件相关的功能：

• 语法高亮

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

• 检查

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

  

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

• 代码补全

  PyCharm 提供广泛的补全支持，帮助您更快地编写 GitHub workflow 和 action。 其中包括：

  • 对多种 GitHub Actions 上下文提供补全，包括 github.*、 env.*、 steps.* 和 inputs.*。 这简化了复杂 workflow 的编写过程，并减少了查找特定上下文语法和参数所花费的时间。

  • 为 needs 和 runs-on 属性提供作业依赖补全。

  • YAML 结构建议。

  • 为本地 action 和 actions 组织中发布的 action 提供参数、名称和版本的自动补全。

  • 支持 CRON 表达式，并对计划 workflow 提供验证与补全。

    

  • 提供 Docker 映像与标签建议，以便将 Docker 容器集成到您的 action 中。

  • JavaScript 文件路径补全。

  • 在 action.yml 中支持品牌配置，允许您指定图标和颜色，在 GitHub Marketplace 和 workflow 中直观地区分您的 action。

• 代码导航

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

• 快速文档

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