GitHub Actions

GitHub Actions 是一个持续集成与持续部署（CI/CD）平台，可实现构建、测试和部署流程的自动化。 PhpStorm 能识别 GitHub YAML 文件并为其提供代码辅助功能。 这包括存储于仓库中 .github/workflows 目录下的工作流文件以及存储于 .github/actions 目录下的 action 文件。 有关详细信息，请参阅 GitHub Actions 文档。

PhpStorm 支持以下功能以便处理 GitHub 文件：

• 语法高亮

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

• 检查

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

  

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

• 代码补全

  PhpStorm 提供广泛的补全支持，以帮助您更快速地编写 GitHub 工作流和 action。 包括以下内容：

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

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

  • YAML 结构建议。

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

  • 支持 CRON 表达式，可对计划的工作流进行验证与补全。

    

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

  • JavaScript 文件路径补全。

  • 在 action.yml 中支持品牌设置，让您可以为 GitHub Marketplace 和工作流中的 action 指定图标与颜色以实现可视化区分。

• 代码导航

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

• 快速文档

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