Git Panel
The Git panel is the central UI component for all Git operations in Flowable Design. It appears in the app details view for any app that is connected to a Git repository, and provides access to all Git-related actions, status information, and history.
Location
The Git panel is accessible from the app details page of any Git-connected app. If the app is not yet connected to a Git repository, the panel shows a setup option instead.
Panel Layout
The Git panel consists of the following areas:
Status Area
At the top of the panel, the status area shows:
- Current branch - The name of the active branch (e.g.,
main,feature/approval-flow). - Sync status - Whether the local app is in sync with the remote, has local changes, or is behind the remote. See Sync Status for details.
- Last sync time - When the app was last synchronized with the remote repository.
Action Buttons
The panel provides the following action buttons:
| Action | Description | Required Permission |
|---|---|---|
| Commit | Open the commit dialog to push local changes to the remote. | DESIGN_GIT_PUSH |
| Pull | Fetch and apply remote changes to the local app. | DESIGN_GIT_PUSH |
| Revert | Revert local changes back to the remote version. | DESIGN_GIT_PUSH |
| Create Branch | Create a new branch from the current branch head. | DESIGN_GIT_MANAGE |
| Switch Branch | Switch to a different remote branch. | DESIGN_GIT_MANAGE |
| Create PR | Create a pull request from the current branch. | DESIGN_GIT_PUSH |
| Stash | Temporarily save uncommitted changes. | DESIGN_GIT_PUSH |
| Restore Stash | Restore previously stashed changes. | DESIGN_GIT_PUSH |
Actions are enabled or disabled based on the current sync state and user permissions. For example, Commit is only enabled when there are local changes, and Pull is only enabled when the remote has new commits.
Changed Models List
When local changes exist, the panel lists all modified, added, and removed models with their change type. Each model entry shows:
- The model name and type (BPMN, CMMN, Form, etc.).
- The change type (modified, added, removed).
- An option to view the diff for that model.
Git Setup Form
For apps not yet connected to Git, the Git panel shows the setup form. The form collects:
| Field | Description | Required |
|---|---|---|
| Git Provider | The provider configuration to use for authentication. | Yes |
| Repository URL | The URL of the Git repository to connect to. For provider types that support it, you can browse and select from available repositories. | Yes |
| Branch | The branch to connect to. Default is main. | Yes |
| Sub-path | The subdirectory within the repository for monorepo setups. Leave empty to use the repository root. | No |
Disconnecting from Git
To disconnect an app from its Git repository:
- Open the Git panel.
- Access the Git configuration settings.
- Choose to remove the Git connection.
This removes the Git configuration from the app but does not delete the app's models. The app returns to being a standard, non-Git-connected Design app.
cautionDisconnecting from Git means the app will no longer be tracked in version control. Any uncommitted changes will be preserved in the app but will not be pushed to the repository. Consider committing all changes before disconnecting.