2.3. Web IDE GitHub アクションで試す

手順

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

   このコードスニペットは、redhat-actions/try-in-web-ide コミュニティーアクションの v1 バージョンを実行するジョブを使用して、Try in Web IDE example という名前のワークフローを作成します。ワークフローは、opened アクティビティータイプの pull_request_target イベント でトリガーされます。

3. オプションで、on.pull_request_target.types フィールドからアクティビティータイプを設定し、ワークフローがトリガーされるタイミングをカスタマイズします。reopened および synchronize などのアクティビティータイプが役立つ場合があります。

   例2.2 opened および synchronize アクティビティータイプの両方でワークフローをトリガーする

   on:
     pull_request_target:
       types: [opened, synchronize]

   Copy to Clipboard Toggle word wrap
4. オプションで、example.yml 内で add_comment および add_status GitHub アクション入力を設定します。これらの入力は Try in Web IDE GitHub アクションに送信され、コメントとステータスチェックを行うかどうかをカスタマイズします。