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 3 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
35 changes: 35 additions & 0 deletions docs/howtos/Release_Process_with_PR_Rebase.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# Release Process with PR Rebase
Tweniee marked this conversation as resolved.
Show resolved Hide resolved

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.
Tweniee marked this conversation as resolved.
Show resolved Hide resolved
- 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
```

Tweniee marked this conversation as resolved.
Show resolved Hide resolved
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`.
Tweniee marked this conversation as resolved.
Show resolved Hide resolved

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/Release_Process_with_PR_Rebase.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
.. Release_Process_with_PR_Rebase:

Release Process with PR Rebase
========================

.. mdinclude:: ./Release_Process_with_PR_Rebase.md
Loading