GitHub Actions

GitHub Actions 是一款持续集成和持续交付（CI/CD）平台，允许自动化构建、测试及部署流程。 WebStorm 能识别 GitHub YAML 文件并为其提供代码辅助功能。 包括存储在代码库中 .github/workflows 目录中的 workflow 文件以及存储在 .github/actions 目录中的 action 文件。 有关更多信息，请参阅 GitHub Actions 文档。

WebStorm 支持以下针对 GitHub 文件的功能：

• 语法高亮

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

• 检查

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

  

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

• 代码补全

  WebStorm 提供广泛的补全支持，帮助您更快地编写 GitHub workflow 与 action。 包括以下内容：

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

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

  • YAML 结构建议。

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

  • CRON 表达式支持，包括调度 workflow 的验证和补全功能。

    

  • 推荐 Docker 镜像和标签，以便在 action 中集成 Docker 容器。

  • JavaScript 文件路径补全。

  • action.yml 中的品牌支持，可让您指定图标和颜色，以在 GitHub Marketplace 及 workflow 中直观地区分您的 action。

• 代码导航

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

• 快速文档

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