2.3. 在 Web IDE GitHub 操作中尝试


Web IDE GitHub 操作中的 Try 可以添加到 GitHub 存储库工作流中,以帮助检查人员快速测试由红帽托管的 Eclipse Che 的拉取请求。此操作通过侦听拉取请求事件并提供工厂 URL 来达到此目的,方法是创建一个注释、状态检查或两者。此工厂 URL 从由红帽托管的 Eclipse Che 上的拉取请求分支创建一个新的工作区。

注意

Che 文档存储库https://github.com/eclipse/che-docs是一个现实生命周期示例,Web IDE GitHub 操作中的 Try 可帮助审查程序快速测试拉取请求。进入最新的拉取请求并打开 factory URL 来体验工作流。

图 2.2. 在 Web IDE GitHub 操作中的 Try 创建的拉取请求注释。点徽标会打开检查者的新工作区来测试拉取请求。

图 2.3. 拉取由 Try 在 Web IDE GitHub 操作中创建的拉取请求状态检查。单击"Details"链接会打开新的工作区,供检查者进行测试拉取请求。

2.3.1. 将操作添加到 GitHub 存储库工作流

本节论述了如何将 Web IDE GitHub 操作中的 Try 集成到 GitHub 仓库工作流中。

先决条件

  • GitHub 仓库
  • GitHub 仓库根目录中的 devfile。

流程

  1. 在 GitHub 仓库中,创建一个 .github/workflows 目录(如果还没有存在)。
  2. .github/workflows 目录中创建 example.yml 文件,其内容如下:

    例 2.1. example.yml

    name: Try in Web IDE example
    
    on:
      pull_request_target:
        types: [opened]
    
    jobs:
      add-link:
        runs-on: ubuntu-20.04
        steps:
          - name: Web IDE Pull Request Check
            id: try-in-web-ide
            uses: redhat-actions/try-in-web-ide@v1
            with:
              # GitHub action inputs
    
              # required
              github_token: ${{ secrets.GITHUB_TOKEN }}
    
              # optional - defaults to true
              add_comment: true
    
              # optional - defaults to true
              add_status: true
    Copy to Clipboard Toggle word wrap

    此代码片段在 Web IDE 示例 中创建一个名为 Try 的工作流,其中有一个运行 redhat-actions/try-in-web-ide 社区操作的 v1 版本的作业。工作流在打开的活动类型上的 pull_request_target 事件 上触发。

  3. (可选)配置 on.pull_request_target.types 字段中的活动类型,以便在工作流触发器时进行自定义。重新打开 和同步 活动类型非常有用。

    例 2.2. 在 打开 和同步 活动类型上触发工作流

    on:
      pull_request_target:
        types: [opened, synchronize]
    Copy to Clipboard Toggle word wrap
  4. (可选)在 example.yml 中配置 add_commentadd_status GitHub 操作输入。这些输入会发送到 Web IDE GitHub 操作中的 Try,以自定义是否进行注释和状态检查。

2.3.2. 提供 devfile

建议在存储库的根目录中提供 devfile,以定义由工厂 URL 创建的工作区的开发环境。这样,工作区包含用户查看拉取请求所需的所有内容,如插件、开发命令和其他环境设置。

Che 文档存储库 devfile 是定义良好的有效 devfile 的示例。

返回顶部
Red Hat logoGithubredditYoutubeTwitter

学习

尝试、购买和销售

社区

关于红帽文档

通过我们的产品和服务,以及可以信赖的内容,帮助红帽用户创新并实现他们的目标。 了解我们当前的更新.

让开源更具包容性

红帽致力于替换我们的代码、文档和 Web 属性中存在问题的语言。欲了解更多详情,请参阅红帽博客.

關於紅帽

我们提供强化的解决方案,使企业能够更轻松地跨平台和环境(从核心数据中心到网络边缘)工作。

Theme

© 2025 Red Hat