Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Tweniee/Isssue:#11361 Updated Document for PR release #11512

Merged
merged 9 commits into from
Nov 28, 2023
Merged
Show file tree
Hide file tree
Changes from 5 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/howtos/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
32 changes: 32 additions & 0 deletions docs/howtos/rebasing_a_pull_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# Rebasing a Pull Request
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe the primary title will be shown on the generated page as the result of being automatically propagated from the corresponding .rst file so this would cause it to appear two times. Therefore, let's remove it.


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:
MisRob marked this conversation as resolved.
Show resolved Hide resolved
- 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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A feature branch is not the develop branch, so please remove this line, it's not a step that people should do. I've tried to explain this a bit in the previous review, you're welcome to ask any clarifying questions if it's not clear.

```
After making changes to the code and committing them locally, push your working branch to your fork on GitHub
MisRob marked this conversation as resolved.
Show resolved Hide resolved

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.

6 changes: 6 additions & 0 deletions docs/howtos/rebasing_a_pull_request.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
.. _rebasing_a_pull_request:

Release Process with PR Rebase
MisRob marked this conversation as resolved.
Show resolved Hide resolved
========================
MisRob marked this conversation as resolved.
Show resolved Hide resolved

.. mdinclude:: ./rebasing_a_pull_request.md
Loading