From 10aee05d63c6a086e15cbe8572c4cab8e180badb Mon Sep 17 00:00:00 2001 From: Eduard Dumitru Date: Tue, 16 Jan 2024 12:12:15 +0100 Subject: [PATCH] Update README.md --- README.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/README.md b/README.md index 55bef4689fca..f7d9cf7d78b3 100644 --- a/README.md +++ b/README.md @@ -9,6 +9,32 @@ From time to time there is a need to merge the changes from the original repo in | --- | --- | |**Original corresponding commit hash:**| `d50aef95520df4216c638495a6049125c00742cb` | +## Update Guide + +- consider the new Base Git Tag from the official repo onto which we'll rebase our changes + + > **NOTE** For simplicity, let's consider `2.11.2` is the tag we want to rebase onto. + +- sync our fork to include that Git Tag. On local, after cloning UiPath/FreeRdp, execute the following: + + ```pwsh + git fetch --tags --all # this will fetch all tags from all upstreams, including from FreeRdp/FreeRdp + git push --tags # this will push the new tags to UiPath/FreeRdp + ``` +- checkout the `uipath` branch +- ‼️ create a new branch to backup the current state (i.e. `support/before_update_to_2_11_2`) +- create **and checkout** a new branch that will be used as a work branch (i.e. `feat/update_to_2_11_2`) + +- identify the Commit Hash, which is the parent of our 1st customization Commit + + > **NOTE** At the time of writing, our 1st customization Commit's message's 1st line is `Add uipath changes from previous version (2.0.0-rc3)` + +- Make sure you've checked out the work branch (i.e. `feat/update_to_2_11_2), and run **git rebase --onto**, so that all UiPath customization commits are replayed onto the new Base Git Tag: + + ```pwsh + git rebase --onto + ``` + ### Build instructions * Visual Studio 2022 installed in `C:\Program Files` required.