Skip to content
redhat-actions

GitHub Action

Try in Web IDE

v1 Latest version
Use latest version
redhat-actions

Try in Web IDE

Try in Web IDE

Installation

Copy and paste the following snippet into your .yml file.

- name: Try in Web IDE
  uses: redhat-actions/try-in-web-ide@v1
Learn more about this action in redhat-actions/try-in-web-ide
Choose a version

Try in Web IDE

CI Checks Contribute

GitHub action will add a comment and/or status check with a link to open the project on an online web IDE instance.

Adding a link in PR status check:

Status check screenshot

Adding a link in PR comment:

Comment screenshot

Usage

# Add Web IDE link on PRs
name: web-ide

on:
  pull_request_target:
    types: [opened, synchronize]

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_token: ${{ secrets.GITHUB_TOKEN }}

Action Inputs

Input Name Description Default
github_token GitHub token used to add PR comment and/or status check. Must be provided
add_comment If true, the action will add comments on each PR with a link to try the PR in Web IDE. true
add_status If true, the action will add a PR status check on each PR with a link to try the PR in Web IDE. true
web_ide_instance The base url for the web IDE instance. https://workspaces.openshift.com
comment_badge The badge url for the comment created when add_comment is true. https://img.shields.io/badge/Eclipse_Che-Hosted%20by%20Red%20Hat-525C86?logo=eclipse-che&labelColor=FDB940

Scenarios

Add comment on pull requests

- name: Web IDE Pull Request Check
  id: try-in-web-ide
  uses: redhat-actions/try-in-web-ide@v1
  with:
    github_token: ${{ secrets.GITHUB_TOKEN }}
    add_comment: false

Disable status check on pull requests

- name: Web IDE Pull Request Check
  id: try-in-web-ide
  uses: redhat-actions/try-in-web-ide@v1
  with:
    github_token: ${{ secrets.GITHUB_TOKEN }}
    add_status: false

Customize the link to online Web IDE instance

- name: Web IDE Pull Request Check
  id: try-in-web-ide
  uses: redhat-actions/try-in-web-ide@v1
  with:
    github_token: ${{ secrets.GITHUB_TOKEN }}
    web_ide_instance: https://my-online-ide-instance.com

Contributing

Running the linter

npm run lint

Generating dist/index.js

npm run bundle

Updating the GitHub action's input and output

After updating action.yml, run:

npx action-io-generator -o src/generated/inputs-outputs.ts

Running tests

npm run test