Skip to content

Commit

Permalink
Document that relnotes branches must be rebased
Browse files Browse the repository at this point in the history
Merging, as the old docs say, results in a PR that can't be merged.

> This branch cannot be rebased due to conflicts

Even if there are no commit on devel and not on the PR branch.

> git log origin/devel ^merge_relnotes16

Signed-off-by: Daniel Farrell <[email protected]>
  • Loading branch information
dfarrell07 authored and sridhargaddam committed Oct 25, 2023
1 parent 90134a8 commit 6cee8fc
Showing 1 changed file with 4 additions and 5 deletions.
9 changes: 4 additions & 5 deletions src/content/development/release-process/_index.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,11 +66,10 @@ resolved before the branch can be merged.

The release notes are maintained in reverse chronological order. Each version should have its release date added in the release note merge PR.

See [the 0.15.2 merge PR](https://github.com/submariner-io/submariner-website/pull/991) for an example of a release note merge PR: it
contains all the commits which built up the release notes, and a final merge commit from `devel` to resolve conflicts. The result only
contains changes to the release notes `_index.en.md` file, with the changes for the released version. If additional changes need to be
added to a pending merge branch, they should be merged to the release notes branch and that branch then merged to the pending merge branch
(which will result in a fast-forward merge). The updated pending merge branch can then be force-pushed to GitHub to update the PR.
Our GitHub configuration requires a rebase before merging PRs, which means we need to use `git rebase` instead of `git merge`.
See [the 0.16.0 PR](https://github.com/submariner-io/submariner-website/pull/1056) for an example. If additional changes need to be added,
they should be added to the release notes branch first. If the initial PR is still pending, they can then be rebased onto the PR's branch.
If the initial PR has been merged, they can be rebased onto devel and submitted with an additional PR.

### Updating Dependencies

Expand Down

0 comments on commit 6cee8fc

Please sign in to comment.