Skip to content

Update release docs to document the need for a temporary brach#13694

Merged
jorgefilipecosta merged 1 commit intomasterfrom
update/release-docs
Feb 11, 2019
Merged

Update release docs to document the need for a temporary brach#13694
jorgefilipecosta merged 1 commit intomasterfrom
update/release-docs

Conversation

@jorgefilipecosta
Copy link
Copy Markdown
Member

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.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

And should we do the same updates done here for the RC release?

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

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.

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.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

The problem here is that you're running the master e2e tests because you've rebased, ideally we run the e2e tests before rebasing :)

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Hi @youknowriad I updated the docs to avoid this problem in the process.

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`.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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"

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

[Type] Developer Documentation Documentation for developers

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants