Chrome extension for Serverless Workflow editor on GitHub

The Google Chrome extension for the Serverless Workflow editor enables you to view and edit CNCF Serverless Workflow specification files in GitHub.

This document describes how to install and use the Chrome extension for Serverless Workflow editor on GitHub.

Installing the Chrome extension for Serverless Workflow editor on GitHub

You can install the Chrome extension for the Serverless Workflow editor to view and edit the workflow specification files in GitHub.

Prerequisites

  • Google Chrome is installed.

Procedure

  1. You can install the Chrome extension using one of the following methods:

    • Go to Chrome web store: Go to the Serverless Workflow Editor for GitHub extension page in Chrome web store and click Add to Chrome.

      swf editor chrome extension page
      Figure 1. Serverless Workflow Chrome extension page

    • Download the ZIP file:

      1. Download and extract the chrome_extension_serverless_workflow_editor_VERSION.zip file from the kie-tools releases page in GitHub.

      2. Go to Customize and control → Settings → Extensions → Load unpacked in the upper-right corner in Chrome.

      3. Open the extracted dist folder.

      The Chrome extension for Serverless Workflow editor is successfully installed.

Using the Chrome extension for Serverless Workflow editor on GitHub

After installing the Chrome extension for the Serverless Workflow editor, you can use the editor to edit and view the workflow files in GitHub.

Prerequisites
Procedure

  1. Create a workflow file (.sw.json or .sw.yaml).

  2. Push the created workflow file to GitHub, or you can go to the GitHub page and click on the workflow file to open in the editor.

    swf editor in github readonly
    Figure 2. Serverless Workflow file in GitHub(read-only mode)

  3. To change the read-only mode to edit mode, click the pencil icon on the top-right corner of the screen.

    swf editor in github edit
    Figure 3. Serverless Workflow file in GitHub(edit mode)

  4. You can switch to the full-screen mode. Also, you can hide the editor and view the source code using the See as source button.

  5. Make changes to the source code, and add a commit message. You can either commit the changes to a branch directly or create a new branch for pull requests.

  6. In a pull request, you can switch between the original and the changes using the buttons provided.

swf editor in github pr
Figure 4. Serverless Workflow file in GitHub(pr mode)

Found an issue?

If you find an issue or any misleading information, please feel free to report it here. We really appreciate it!