Update release docs to document the need for a temporary brach #13694
Conversation
jorgefilipecosta
added
the
[Type] Developer Documentation
jorgefilipecosta
requested review from
ajitbohra,
chrisvanpatten,
gziolo,
mkaz,
oandregal and
youknowriad
as code owners
docs/contributors/release.md
Outdated
| 4. Tag the version. `git tag vx.x.0` from the release branch. | ||
| 5. Push the tag `git push --tags`. | ||
| 6. Merge the version bump pull request and avoid removing the release branch. | ||
| 3. Tag the version. `git tag vx.x.0` from the release branch. |
There was a problem hiding this comment.
I think we should add an entry before this to ensure the tests are ok. The PR was used for it but maybe we could do it manually instead? or create a temporary PR?
There was a problem hiding this comment.
And should we do the same updates done here for the RC release?
There was a problem hiding this comment.
The process was updated to make sure the CI tests pass before creating the tag.
And should we do the same updates done here for the RC release?
For the RC release, I don't think we need a temporary branch as in that case there are no conflicts.
jorgefilipecosta
force-pushed
the
update/release-docs
branch
from
3042272
to
140b682
Compare
docs/contributors/release.md
Outdated
| 6. Merge the version bump pull request and avoid removing the release branch. | ||
| 3. Create a new branch called `bump/x.x` from `release/x.x` and switch to it: `git checkout -b bump/x.x`. | ||
| 4. Make sure the master branch is updated and rebase `bump/x.x` against it `git rebase master`. | ||
| 5. Create a pull request from `bump/x.x` to `master`. Verify there are no conflicts and the continuous integrations tests pass. |
There was a problem hiding this comment.
The problem here is that you're running the master e2e tests because you've rebased, ideally we run the e2e tests before rebasing :)
There was a problem hiding this comment.
Hi @youknowriad I updated the docs to avoid this problem in the process.
jorgefilipecosta
force-pushed
the
update/release-docs
branch
from
140b682
to
8c4b7dd
Compare
docs/contributors/release.md
Outdated
| 6. Merge the version bump pull request and avoid removing the release branch. | ||
| 3. Create a new branch called `bump/x.x` from `release/x.x` and switch to it: `git checkout -b bump/x.x`. | ||
| 4. Create a pull request from `bump/x.x` to `master`. Verify the continuous integrations tests pass, before continuing to the next step even if conflicts exist. | ||
| 5. Make sure the master branch is updated and rebase `bump/x.x` against it `git rebase master`. |
There was a problem hiding this comment.
You could replace this git rebase master by git fetch origin && git rebase origin/master to avoid having to specify "Make sure the master branch"
…n official releases version bumps
jorgefilipecosta
force-pushed
the
update/release-docs
branch
from
8c4b7dd
to
95e4fd6
Compare
Description
A small update to release specifying the need to use a temporary branch to perform the version bump during official release.
In this case, we know a conflict will always exist and given that we can not rebase release branch, another branch should be used.