DataGrip 2025.2 Help

GitHub Actions

GitHub Actions 是一个持续集成与持续交付(CI/CD)平台,可用于自动化构建、测试和部署流水线。DataGrip 能识别 GitHub YAML 文件并提供代码辅助功能。 DataGrip 能识别 GitHub YAML 文件并提供代码辅助功能。 这包括存储在您的版本库中 .github/workflows 目录下的工作流程文件与存储在 .github/actions 目录下的操作文件。 如需了解更多信息,请参阅 GitHub Actions 文档

安装 GitHub 插件

此功能依赖于 GitHub 插件,您需要安装并启用它。

  1. Ctrl+Alt+S 打开设置,然后选择 Plugins

  2. 打开 Marketplace 选项卡,找到 GitHub 插件,然后单击 安装 (如果提示,请重启 IDE)。

DataGrip 支持以下功能以使用 GitHub 文件:

  • 语法高亮

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

  • 检查

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

    检查示例:未定义的作业依赖项

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

  • 代码补全

    DataGrip 提供强大的补全支持,可帮助您更快速地编写 GitHub 工作流程与操作。 包括以下内容:

    • 支持多种 GitHub Actions 上下文的补全,包括 github.*env.*steps.*inputs.*。 这简化了编写复杂工作流程脚本的过程,并减少了查找上下文相关语法和参数所需的时间。

    • needsruns-on 属性提供作业依赖项补全。

    • YAML 结构建议。

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

    • 支持 CRON 表达式的验证与补全,用于计划工作流程。

      GitHub 文件中的 CRON 表达式
    • 提供 Docker 镜像与标签建议,使 Docker 容器可以集成到操作中。

    • JavaScript 文件路径补全。

    • action.yml 中支持品牌设置,允许您为操作在 GitHub Marketplace 和工作流程中指定图标与颜色,以提升可视识别度。

  • 代码导航

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

  • 快速文档

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

创建新的 GitHub 工作流程

  1. 个文件 工具窗口中,右键单击 .github/workflows 目录,然后选择 新建 (或按 Alt+Insert)。 然后,选择 GitHub 工作流 文件类型。

  2. 新建GitHub 工作流文件 对话框中,指定文件名并按下 Enter

创建新的 GitHub 操作

  1. 个文件 工具窗口中,右键单击 .github/actions 目录,然后选择 新建 (或按 Alt+Insert)。 然后,选择 GitHub 操作 文件类型。

  2. 新建GitHub 操作文件 对话框中,指定文件名并按下 Enter

最后修改日期: 2025年 9月 26日