Integrating your SonataFlow project in GitHub using Serverless Logic Web Tools

The Serverless Logic Web Tools implements a web version of a Git client, enabling you to clone, create, commit, push, and pull repositories. This process synchronizes your workspaces remotely.

This document describes how you can configure the integration and synchronize your projects.

Setting your GitHub token in Serverless Logic Web Tools

You can generate a token from your GitHub account and add the token to the Serverless Logic Web Tools.

Prerequisites

  • You have a GitHub account.

Procedure

  1. Go to Serverless Logic Web Tools web application, and click the Cogwheel (⚙️) in the top-right corner of the screen.

  2. Go to the GitHub tab.

  3. In the GitHub tab, click the Add access token button and a window will be shown.

  4. Click Create a new token option.

    Ensure that you select the repo option.

  5. Optionally, select gist, which enables you to import and update gists.

  6. Copy the generated token and paste it into the Token field in Serverless Logic Web Tools GitHub Settings.

    The contents of the tab are updated and display that you are signed into GitHub and have all the required permissions.

Synchronizing your workspaces with GitHub

After your GitHub token is set, you can synchronize your workspaces with remote repositories.

Prerequisites
Procedure

  1. In the Serverless Logic Web Tools web application, create or open a workspace.

  2. Add or edit the existing files in the workspace.

  3. Click Share → GitHub: Create Repository.

  4. Name your repository and set the repository as Public or Private.

  5. (Optional) Select the Use Quarkus Accelerator to create a repository with a base Quarkus project and move the workspace files to src/main/resources folder.

    serverless logic web tools github repo
    Figure 1. Create a repository for your workspace

  6. Click Sync → Push to update the remote repository with your local changes.

  7. To get new updates from the remote repository, click Sync → Pull.

    Currently, Serverless Logic Web Tools cannot resolve the merge conflicts. Therefore, ensure that you always pull changes before working on your files.

Importing a workspace from GitHub

You can import a workspace from GitHub in Serverless Logic Web Tools when you need to work from another computer or need to use someone else’s workspace.

Prerequisites
Procedure

  1. Go to GitHub, find the repository with your project, and copy the repository URL.

  2. In Serverless Logic Web Tools web application, paste the repository URL in the Import → From URL field and click Clone.

    The page loads your imported project, defaulting to a workflow file, if present.

  3. If applicable, you can push to the imported repository by clicking on the Sync → Push.

Found an issue?

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