From 3e91df9e4521a92923e688dc7b5332f49e181c15 Mon Sep 17 00:00:00 2001 From: Abhishek upadhyay <93429474+Tweniee@users.noreply.github.com> Date: Thu, 9 Nov 2023 10:30:34 +0530 Subject: [PATCH 1/8] Create Release_Process_with_PR_Rebase.md --- docs/howtos/Release_Process_with_PR_Rebase.md | 35 +++++++++++++++++++ 1 file changed, 35 insertions(+) create mode 100644 docs/howtos/Release_Process_with_PR_Rebase.md diff --git a/docs/howtos/Release_Process_with_PR_Rebase.md b/docs/howtos/Release_Process_with_PR_Rebase.md new file mode 100644 index 0000000000..cd8e6c4131 --- /dev/null +++ b/docs/howtos/Release_Process_with_PR_Rebase.md @@ -0,0 +1,35 @@ +# Release Process with PR Rebase + +Rebasing your pull requests keeps your commit history clean and integrates changes from the main branch, ensuring a smoother merge. + +**Note:** the current release is tagged as `release-v*`. Replace `release-v*` with the actual version. + +#### Before creating a new local working branch: + - Make sure you have local versions of the Learning Equality `develop` branch and the Learning Equality `release-v*` branch. + - Ensure that both branches are up to date. For this guide, we'll assume they are named `develop` and `release-v*`, respectively. + +Checkout the upstream develop branch: +``` +git checkout develop +``` +After making changes to the code and committing them locally, push your working branch to your fork on GitHub: + +``` +git push origin develop +``` + +Now run the following rebase command: + +``` +git rebase --onto release-v* develop +``` +This command will rebase your current branch `develop` onto `release-v*`, removing any commits that are already present in `develop`. + +After completing the rebase, you will need to force push to update your remote branch. Use the following command: + +``` +git push --force +``` + +**Caution:** Handle force-pushes with care. + From afdc2c85712f9df2384f9f2ac303af86c5b2c713 Mon Sep 17 00:00:00 2001 From: Abhishek upadhyay <93429474+Tweniee@users.noreply.github.com> Date: Thu, 9 Nov 2023 10:32:12 +0530 Subject: [PATCH 2/8] Create Release_Process_with_PR_Rebase.rst --- docs/howtos/Release_Process_with_PR_Rebase.rst | 6 ++++++ 1 file changed, 6 insertions(+) create mode 100644 docs/howtos/Release_Process_with_PR_Rebase.rst diff --git a/docs/howtos/Release_Process_with_PR_Rebase.rst b/docs/howtos/Release_Process_with_PR_Rebase.rst new file mode 100644 index 0000000000..92632e6ed5 --- /dev/null +++ b/docs/howtos/Release_Process_with_PR_Rebase.rst @@ -0,0 +1,6 @@ +.. Release_Process_with_PR_Rebase: + +Release Process with PR Rebasee +======================== + +.. mdinclude:: ./Release_Process_with_PR_Rebase.md From 3a4d563e47de0b268aa63e7c0e74399bb004c7b8 Mon Sep 17 00:00:00 2001 From: Abhishek upadhyay <93429474+Tweniee@users.noreply.github.com> Date: Thu, 9 Nov 2023 10:32:47 +0530 Subject: [PATCH 3/8] Update Release_Process_with_PR_Rebase.rst --- docs/howtos/Release_Process_with_PR_Rebase.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/howtos/Release_Process_with_PR_Rebase.rst b/docs/howtos/Release_Process_with_PR_Rebase.rst index 92632e6ed5..82914a6fa9 100644 --- a/docs/howtos/Release_Process_with_PR_Rebase.rst +++ b/docs/howtos/Release_Process_with_PR_Rebase.rst @@ -1,6 +1,6 @@ .. Release_Process_with_PR_Rebase: -Release Process with PR Rebasee +Release Process with PR Rebase ======================== .. mdinclude:: ./Release_Process_with_PR_Rebase.md From 2d623c7d757c65ff633bec52ea50e4ec182934e7 Mon Sep 17 00:00:00 2001 From: Tweniee Date: Wed, 15 Nov 2023 10:01:10 +0530 Subject: [PATCH 4/8] Minor changes done and renamed the doc --- docs/howtos/Release_Process_with_PR_Rebase.md | 35 ------------------- .../howtos/Release_Process_with_PR_Rebase.rst | 6 ---- docs/howtos/rebasing_a_pull_request.md | 32 +++++++++++++++++ docs/howtos/rebasing_a_pull_request.rst | 6 ++++ 4 files changed, 38 insertions(+), 41 deletions(-) delete mode 100644 docs/howtos/Release_Process_with_PR_Rebase.md delete mode 100644 docs/howtos/Release_Process_with_PR_Rebase.rst create mode 100644 docs/howtos/rebasing_a_pull_request.md create mode 100644 docs/howtos/rebasing_a_pull_request.rst diff --git a/docs/howtos/Release_Process_with_PR_Rebase.md b/docs/howtos/Release_Process_with_PR_Rebase.md deleted file mode 100644 index cd8e6c4131..0000000000 --- a/docs/howtos/Release_Process_with_PR_Rebase.md +++ /dev/null @@ -1,35 +0,0 @@ -# Release Process with PR Rebase - -Rebasing your pull requests keeps your commit history clean and integrates changes from the main branch, ensuring a smoother merge. - -**Note:** the current release is tagged as `release-v*`. Replace `release-v*` with the actual version. - -#### Before creating a new local working branch: - - Make sure you have local versions of the Learning Equality `develop` branch and the Learning Equality `release-v*` branch. - - Ensure that both branches are up to date. For this guide, we'll assume they are named `develop` and `release-v*`, respectively. - -Checkout the upstream develop branch: -``` -git checkout develop -``` -After making changes to the code and committing them locally, push your working branch to your fork on GitHub: - -``` -git push origin develop -``` - -Now run the following rebase command: - -``` -git rebase --onto release-v* develop -``` -This command will rebase your current branch `develop` onto `release-v*`, removing any commits that are already present in `develop`. - -After completing the rebase, you will need to force push to update your remote branch. Use the following command: - -``` -git push --force -``` - -**Caution:** Handle force-pushes with care. - diff --git a/docs/howtos/Release_Process_with_PR_Rebase.rst b/docs/howtos/Release_Process_with_PR_Rebase.rst deleted file mode 100644 index 82914a6fa9..0000000000 --- a/docs/howtos/Release_Process_with_PR_Rebase.rst +++ /dev/null @@ -1,6 +0,0 @@ -.. Release_Process_with_PR_Rebase: - -Release Process with PR Rebase -======================== - -.. mdinclude:: ./Release_Process_with_PR_Rebase.md diff --git a/docs/howtos/rebasing_a_pull_request.md b/docs/howtos/rebasing_a_pull_request.md new file mode 100644 index 0000000000..6d51b19fec --- /dev/null +++ b/docs/howtos/rebasing_a_pull_request.md @@ -0,0 +1,32 @@ +# Rebasing a Pull Request + +On certain occasions, it might be necessary to redirect a pull request from the develop branch to the latest release branch, such as `release-v*` (e.g., `release-v0.16.x` when working on version 0.16), or vice versa. This guide outlines the steps for rebasing a feature branch related to your pull request while maintaining a clean commit history. + +The demonstration centers on the process of rebasing a feature branch that is directed towards the `develop` branch in your pull request, transitioning it to the most recent release branch, identified as `release-v*`. If the need arises to rebase your pull request in the opposite direction—from `release-v*` to `develop` you can follow the same steps, just adjusting the branch names as indicated in the guide below. + + +#### Before creating a new local working branch: + - Make sure you have local versions of the `develop` branch and the `release-v*` branch. + - Ensure that both branches are up to date. For this guide, we'll assume they are named `develop` and `release-v*`, respectively. + +Locally, checkout your feature branch (that you previously created off the develop): +``` +git checkout develop +``` +After making changes to the code and committing them locally, push your working branch to your fork on GitHub + +And run the following rebase command: + +``` +git rebase --onto release-v* develop +``` +This command will rebase your current feature branch onto `release-v*`, removing any commits that are already present in `develop`. + +After completing the rebase, you will need to force push to update your remote branch. Use the following command: + +``` +git push --force +``` + +**Caution:** Handle force-pushes with care. + diff --git a/docs/howtos/rebasing_a_pull_request.rst b/docs/howtos/rebasing_a_pull_request.rst new file mode 100644 index 0000000000..9e86732fed --- /dev/null +++ b/docs/howtos/rebasing_a_pull_request.rst @@ -0,0 +1,6 @@ +.. _rebasing_a_pull_request: + +Release Process with PR Rebase +======================== + +.. mdinclude:: ./rebasing_a_pull_request.md From 1647f961f6d4c93813d08bcd2dee7b819976483e Mon Sep 17 00:00:00 2001 From: Abhishek upadhyay <93429474+Tweniee@users.noreply.github.com> Date: Wed, 15 Nov 2023 10:04:24 +0530 Subject: [PATCH 5/8] Update index.rst --- docs/howtos/index.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/howtos/index.rst b/docs/howtos/index.rst index 4de513f7fd..f83ecf881d 100644 --- a/docs/howtos/index.rst +++ b/docs/howtos/index.rst @@ -13,3 +13,4 @@ These guides are step by step guides for common tasks in getting started and wor pyenv_virtualenv nodeenv another_kolibri_instance + rebasing_a_pull_request From 824822a7db6811cb9d82dda3d7af9383f5f036f8 Mon Sep 17 00:00:00 2001 From: Tweniee Date: Mon, 20 Nov 2023 22:14:15 +0530 Subject: [PATCH 6/8] minor doc story --- docs/howtos/rebasing_a_pull_request.md | 6 ++---- docs/howtos/rebasing_a_pull_request.rst | 4 ++-- 2 files changed, 4 insertions(+), 6 deletions(-) diff --git a/docs/howtos/rebasing_a_pull_request.md b/docs/howtos/rebasing_a_pull_request.md index 6d51b19fec..d620de73ff 100644 --- a/docs/howtos/rebasing_a_pull_request.md +++ b/docs/howtos/rebasing_a_pull_request.md @@ -2,18 +2,16 @@ On certain occasions, it might be necessary to redirect a pull request from the develop branch to the latest release branch, such as `release-v*` (e.g., `release-v0.16.x` when working on version 0.16), or vice versa. This guide outlines the steps for rebasing a feature branch related to your pull request while maintaining a clean commit history. -The demonstration centers on the process of rebasing a feature branch that is directed towards the `develop` branch in your pull request, transitioning it to the most recent release branch, identified as `release-v*`. If the need arises to rebase your pull request in the opposite direction—from `release-v*` to `develop` you can follow the same steps, just adjusting the branch names as indicated in the guide below. +The demonstration centers on the process of rebasing a feature branch that is directed towards the `develop` branch in your pull request, transitioning it to the most recent release branch, identified as `release-v*`. If the need arises to rebase your pull request in the opposite direction—from `release-v*` to `develop` you can follow the same steps, just adjusting the branch names as indicated in the guide below. -#### Before creating a new local working branch: - Make sure you have local versions of the `develop` branch and the `release-v*` branch. - Ensure that both branches are up to date. For this guide, we'll assume they are named `develop` and `release-v*`, respectively. -Locally, checkout your feature branch (that you previously created off the develop): +Locally, checkout your feature branch: ``` git checkout develop ``` -After making changes to the code and committing them locally, push your working branch to your fork on GitHub And run the following rebase command: diff --git a/docs/howtos/rebasing_a_pull_request.rst b/docs/howtos/rebasing_a_pull_request.rst index 9e86732fed..ed587fabca 100644 --- a/docs/howtos/rebasing_a_pull_request.rst +++ b/docs/howtos/rebasing_a_pull_request.rst @@ -1,6 +1,6 @@ .. _rebasing_a_pull_request: -Release Process with PR Rebase -======================== +Rebasing a Pull Request +======================= .. mdinclude:: ./rebasing_a_pull_request.md From d565c39f7ff83e586b154a13aef6da597db74fac Mon Sep 17 00:00:00 2001 From: Tweniee Date: Wed, 22 Nov 2023 15:43:49 +0530 Subject: [PATCH 7/8] removed develop feature branch name and heading --- docs/howtos/rebasing_a_pull_request.md | 9 +-------- 1 file changed, 1 insertion(+), 8 deletions(-) diff --git a/docs/howtos/rebasing_a_pull_request.md b/docs/howtos/rebasing_a_pull_request.md index d620de73ff..2b90fc1504 100644 --- a/docs/howtos/rebasing_a_pull_request.md +++ b/docs/howtos/rebasing_a_pull_request.md @@ -1,5 +1,3 @@ -# Rebasing a Pull Request - On certain occasions, it might be necessary to redirect a pull request from the develop branch to the latest release branch, such as `release-v*` (e.g., `release-v0.16.x` when working on version 0.16), or vice versa. This guide outlines the steps for rebasing a feature branch related to your pull request while maintaining a clean commit history. The demonstration centers on the process of rebasing a feature branch that is directed towards the `develop` branch in your pull request, transitioning it to the most recent release branch, identified as `release-v*`. If the need arises to rebase your pull request in the opposite direction—from `release-v*` to `develop` you can follow the same steps, just adjusting the branch names as indicated in the guide below. @@ -8,12 +6,7 @@ The demonstration centers on the process of rebasing a feature branch that is di - Make sure you have local versions of the `develop` branch and the `release-v*` branch. - Ensure that both branches are up to date. For this guide, we'll assume they are named `develop` and `release-v*`, respectively. -Locally, checkout your feature branch: -``` -git checkout develop -``` - -And run the following rebase command: +Locally, checkout your feature branch and run the following rebase command: ``` git rebase --onto release-v* develop From ddd86f9c1569e169feae7191ba999f0c9eda2c79 Mon Sep 17 00:00:00 2001 From: Abhishek Upadhyay Date: Tue, 28 Nov 2023 20:15:15 +0530 Subject: [PATCH 8/8] linting --- docs/howtos/rebasing_a_pull_request.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/docs/howtos/rebasing_a_pull_request.md b/docs/howtos/rebasing_a_pull_request.md index 2b90fc1504..623e842099 100644 --- a/docs/howtos/rebasing_a_pull_request.md +++ b/docs/howtos/rebasing_a_pull_request.md @@ -5,7 +5,7 @@ The demonstration centers on the process of rebasing a feature branch that is di - Make sure you have local versions of the `develop` branch and the `release-v*` branch. - Ensure that both branches are up to date. For this guide, we'll assume they are named `develop` and `release-v*`, respectively. - + Locally, checkout your feature branch and run the following rebase command: ``` @@ -20,4 +20,3 @@ git push --force ``` **Caution:** Handle force-pushes with care. -