Try in Web IDE GitHub action

In the GitHub repository, create a .github/workflows directory if it does not exist already.

Create an example.yml file in the .github/workflows directory with the following content:

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

Optionally configure the activity types from the on.pull_request_target.types field to customize when workflow trigger. Activity types such as reopened and synchronize can be useful.

on:
  pull_request_target:
    types: [opened, synchronize]

Optionally configure the add_comment and add_status GitHub action inputs within example.yml. These inputs are sent to the Try in Web IDE GitHub action to customize whether comments and status checks are to be made.