-
Notifications
You must be signed in to change notification settings - Fork 732
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
Changes from 5 commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
3e91df9
Create Release_Process_with_PR_Rebase.md
Tweniee afdc2c8
Create Release_Process_with_PR_Rebase.rst
Tweniee 3a4d563
Update Release_Process_with_PR_Rebase.rst
Tweniee 2d623c7
Minor changes done and renamed the doc
Tweniee 1647f96
Update index.rst
Tweniee d1b93df
Merge branch 'learningequality:develop' into develop
Tweniee 824822a
minor doc story
Tweniee d565c39
removed develop feature branch name and heading
Tweniee ddd86f9
linting
Tweniee File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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: | ||
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 | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. A feature branch is not the |
||
``` | ||
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. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
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.