DataSpell 2025.2 Help

GitHub Actions

GitHub Actions 是一种持续集成与持续交付平台(CI/CD),可用于自动化构建、测试和部署流程。DataSpell 可识别 GitHub YAML 文件,并提供编码辅助支持。这包括存储在仓库中 .github/workflows 目录中的 workflow 文件,以及存储在 .github/actions 目录中的 action 文件。有关更多信息,请参阅 GitHub Actions 文档。 DataSpell 可识别 GitHub YAML 文件,并提供编码辅助支持。 这包括存储在仓库中 .github/workflows 目录中的 workflow 文件,以及存储在 .github/actions 目录中的 action 文件。 有关更多信息,请参阅 GitHub Actions 文档

DataSpell 在使用 GitHub 文件时支持以下功能:

  • 语法高亮

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

  • 检查

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

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

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

  • 代码补全

    DataSpell 提供广泛的补全支持,帮助您更快速地编写 GitHub workflow 和 action。 包括以下内容:

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

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

    • YAML 结构建议。

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

    • 支持 CRON 表达式的验证和补全,适用于计划运行的 workflow。

      GitHub 文件中的 CRON 表达式
    • 提供 Docker 镜像及标签建议,以便将 Docker 容器集成到您的 action 中。

    • JavaScript 文件路径补全。

    • action.yml 中支持品牌设置,使您可以为 action 指定图标和颜色,在 GitHub Marketplace 和 workflow 中实现可视区分。

  • 代码导航

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

  • 快速文档

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

创建新的 GitHub workflow

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

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

创建新的 GitHub action

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

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

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