[DevSecOps] From GitHub Issue to Merging a Pull Request

News Vote on Tutorials
1

About the [DevSecOps] series of tutorials

This series of tutorials will focus on Development, Security and Operations regarding GIT Versioning Systems.
It will cover areas such as:

  • GIT integration
  • Branches & Pull Requests
  • CI/CD (Continuous Integration/Continuous Delivery)
    And much more…
DevSecOps Series
Connect a UiPath Project to a GitHub repository
From GitHub Issue to Merging a Pull Request
Common GIT Actions in UiPath Studio

Introduction to this tutorial

This guide will show you how to go from:

  1. A GitHub Issue (bug request)
  2. Creating a branch from this issue
  3. Working on fixing the bug in UiPath Studio (on the branch)
  4. Committing changes to GitHub linked to the issue
  5. Creating a Pull Request in GitHub to review the changes
  6. Merging the changes into the production code and finalizing the issue process

The primary purpose of this tutorial is to show the synergy between the end user (bug reporter) and developer through the bug fixing process.

Creating the issue in GitHub and branching from this

  • A user with access to your repository has the ability to create a new issue by pressing the New Issue button from the Issues pane

1 new issue
1 new issue790×223 16.7 KB

  • A description of the issue/bug should be filled out and perhaps addition of attachment(s) for visual documentation

3 issue description
3 issue description955×536 20.1 KB

  • The developer now has the option to create a new branch directly from this issue

4 create a branch from issue
4 create a branch from issue1247×532 47.4 KB

  • Pay attention to the new Branch name and then press Create branch

5 create branch
5 create branch457×451 20.3 KB

Switching to the new branch in UiPath Studio

  • Inside UiPath Studio you should now Refresh remote branches by clicking in the bottom right corner

6 refresh remote branches
6 refresh remote branches389×245 9.84 KB

  • Select the new branch from the list of available ones (name from before), and remember to press Pull (rebase) afterwards, to pull your branch from the remote repository to your local repository

7 new branch appeared
7 new branch appeared547×271 12.9 KB

8 pull rebase new branch
8 pull rebase new branch565×296 12 KB

Committing the changes to GitHub with the Issue Key as reference

  • After making changes you need to Commit them to GitHub by clicking on the pencil in the bottom right corner
  • Now type the Issue Key (for GitHub you need to add the # sign before)
    • For this specific issue/branch the Issue Key is #1
    • After the Issue Key you should give a short description of what has changed

11 commit with issue key
11 commit with issue key991×618 32.6 KB

  • When reviewing the branch/issue in GitHub, you should now be able to see the changes linked to the issue. This enables transparency both for the end user (bug reporter) and developer, and ensures synergy throughout the development process.

14 link to issue key
14 link to issue key594×472 26.1 KB

Creating a Pull Request in GitHub and Merging the code

  • The next step is to import/merge your changes from the new branch into the main (production) branch, to effectuate the changes
  • First off click the button Compare & pull request from the branch overview

12 commits ahead of main
12 commits ahead of main917×277 18.9 KB

  • You are now able to review the changes made in the branch before clicking the button Create pull request

13 comparing changes
13 comparing changes1237×675 44.6 KB

15 create pull request
15 create pull request782×287 15.3 KB

  • Fill out a description of what has been made with this branch, or perhaps use GitHub CoPilot to generate a text, by clicking the icon in the top bar (if you have the required license)

16 pull request description
16 pull request description923×660 27.9 KB

  • Now a reviewer (perhaps yourself) should be able to go through your pull request, and if all is fine, he or she could chose to Merge pull request

17 merge pull request
17 merge pull request920×849 53.4 KB

  • Consider deleting the branch afterwards, as its use has now come to an end

18 delete branch
18 delete branch927×115 7.06 KB

Review changes in Issue

  • By linking the Issue Key in commits, the user (bug reporter) has the ability to view the changes from start to end of the development process

19 flow of issue
19 flow of issue898×451 27.5 KB

Please let me know if you have any questions or feedback for this tutorial.

Best Regards
Soren