CLion 2025.2 Help

GitHub Actions

GitHub Actions 是一个持续集成与持续交付(CI/CD)平台,可让您自动化构建、测试与部署流程。 CLion 能识别 GitHub YAML 文件并为其提供代码辅助功能。 其中包括存储于 .github/workflows 目录中的 workflow 文件和存储于 .github/actions 目录中的 action 文件。 如需详细信息,请参阅 GitHub Actions 文档

CLion 支持以下功能以便处理 GitHub 文件:

  • 语法高亮

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

  • 检查

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

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

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

  • 代码补全

    CLion 提供强大的补全支持,帮助您更快速地编写 GitHub workflow 与 action。 包括以下内容:

    • 支持 GitHub Actions 各种上下文的补全,包括 github.*env.*steps.*inputs.*。 这简化了复杂 workflow 的脚本编写过程,并减少了寻找特定上下文语法和参数所花费的时间。

    • needsruns-on 属性的作业依赖关系补全。

    • YAML 结构建议。

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

    • 支持 CRON 表达式,可对计划任务提供验证与补全功能。

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

    • JavaScript 文件路径补全。

    • action.yml 中支持标识功能,允许您为 GitHub Marketplace 与 workflow 中的 action 指定图标与颜色以实现可视化区分。

  • 代码导航

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

  • 快速文档

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

创建新的 GitHub workflow

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

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

创建新的 GitHub action

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

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

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