kie-tooling
Published in

kie-tooling

Workspace collaboration via change requests

A new feature has just been integrated into kiegroup master branches and is available in Business Central releases. This new feature is the workspace collaboration via change requests.

Photo by Joel Filipe on Unsplash

Introduction

The possibility to work with multiple branches in the Business Central authoring environment is highly productive, which makes it necessary to provide a way for users to easily integrate their changes between branches. The most common use case would be users making changes in a feature branch and integrating these changes into the master branch afterward.

With that in mind, the foundation team is introducing a change request flow out of the box, allowing users to submit their changes for approval from one branch to another, as well as the ability to review the changes prior to the integration. The feature is basically divided into three actions: listing, submitting, and reviewing. The following sections briefly walk through each one of them.

Listing

Named Change Requests, a new tab has been added between the Assets and Contributors tabs on the project screen. This new tab presents a list of change requests that have been submitted by users to the project, including both open and closed ones. Let’s dive into each part of the UI.

List of change requests

(1) Badge: Indicate the number of currently open change requests within the selected project;
(2) Filter: Filter the list to show open change requests, closed ones, or all of them;
(3) Search: Search mechanism by id and/or summary;
(4) Submit: Button that opens the submit change request screen;

(5) List of change requests:
(5.1) Status icon: Indicate the status of the change request, which can be open, merged, or rejected.
(5.2) Name: Concat the auto-generated id and the summary defined by the author;
(5.3) Author: The user who has submitted the change request;
(5.4) Date: The amount of time since the change request submission;
(5.5) Changed files counter: The number of changed files included in the change request;
(5.6) Comments counter: The number of comments received in the change request.

Change request in Business Central — List screen

Submitting

The submit change request screen allows users to prepare and submit changes from the current branch to a destination branch. There is a button in the project kebab as well as in the change requests tab that gives access to the aforementioned screen. Let’s dive into each part of the UI.

Submit change request screen

(1) Summary: Short summary of the change request;
(2) Description: A more detailed description of what has been done in the change request;
(3) Submit: Button to submit the change request for the review process;
(4) Target branch: List of destination branches that the user has read access to;
(5) Differences: List of highlighted textual differences between the current and destination branches.

Change request in Business Central — Submit screen

Reviewing

Once submitted, the change request will be available in the change requests tab for all users who have read permission on the destination branch. When clicking on any change request in the change requests tab, a review screen is opened, which contains two tabs: Overview and Changed Files. Let’s dive into each part of the UI.

Overview

This tab includes all the relevant information about the change request, such as summary, description, status, author, submitted date, and involved branches. Additionally, users can interact with each other via comments.

Review change request screen — Overview

Changed Files

Similar to the submit screen, this tab includes all changed files and their corresponding highlighted textual differences. Moreover, the data in the tab will keep reflecting on all the differences between the involved branches as long as the status of the change request is Open.

Review change request screen — Changed Files

Finally, users who have write permission on the destination branch can, besides commenting, either reject or accept the change request. Once accepted, all the changes included in the change request are merged into the destination branch.

Change request in Business Central — Review screen

Demonstration

Let’s demonstrate the flow of the following use case: a developer user, who has limited permissions, will make some changes in a feature branch, then submit a change request to the master branch, and interact with a second user during the review process. This second user, who is the administrator having all the permissions, will review the change request, ask for more changes, and then conclude the process by accepting the change request.

Change request in Business Central — Demo

And that’s all for today. Thanks for reading! 🙂

--

--

--

Tooling Team from kie.org

Recommended from Medium

Making an Existing Application More Functional

Variables and Data Types In Python

How To Run Your First Event Storming Session?

LeetCode 199- Binary Tree Right Side View

Around Memory Forensics in 80 days Part 3 — Volatility process list

Elite Data Engineering

What’s An RFP And Why You Need One For Software Development Outsourcing

Tools To Help With Learning Online, Part 1

Get the Medium app

A button that says 'Download on the App Store', and if clicked it will lead you to the iOS App store
A button that says 'Get it on, Google Play', and if clicked it will lead you to the Google Play store
Guilherme Caponetto

Guilherme Caponetto

Senior software engineer at Red hat & Machine learning researcher

More from Medium

The flat file in webMethods with Demo.

The Accidental Open Source Project

Httplog github page

Running x86 64 Docker images inside Lima VM on mac m1

Installing WSL 2 on Windows 10 and Kafka with Confluent Platform on Ubuntu (local environment…