mirror of https://github.com/citusdata/citus.git
4a9d516f1b
* add a job to check if merge to enterprise master would fail Add a job to check if merge to enterprise master would fail. The job does the following: - It checks if there is already a branch with the same name on enterprise, if so it tries to merge it to enterprise master, if the merge fails the job fails. - If the branch doesn't exist on the enterprise, it tries to merge the current branch to enterprise master, it fails if there is any conflict while merging. The motivation is that if a branch on community would create a conflict on enterprise-master, until we create a PR on enterprise that would solve this conflict, we won't be able to merge the PR on community. This way we won't have many conflicts when merging to enterprise master and the author, who has the most context will be responsible for resolving the conflict when he has the most context, not after 1 month. * Improve test suite to be able to easily run locally * Add documentation on how to resolve conflicts to enterprise master * Improve enterprise merge script * Improve merge conflict job README * Improve merge conflict job README * Improve merge conflict job README * Improve merge conflict job README Co-authored-by: Nils Dijk <nils@citusdata.com> |
||
|---|---|---|
| .. | ||
| README.md | ||
| check_enterprise_merge.sh | ||
README.md
check-merge-to-enterprise Job
When you open a PR on community, if it creates a conflict with enterprise-master, the check-merge-to-enterprise will fail. Say your branch name is X, we will refer to X on community as community/X and on enterprise as enterprise/X. If the job already passes, you are done, nothing further required! Otherwise follow the below steps:
- You first need to get approval from your reviewer for
community/X. Only follow the next steps after you are about to merge the branch to community master. Otherwise, thecheck-merge-to-enterprisecheck might falsely pass. (For example when you added new commits tocommunity/Xbut forgot to updateenterprise/X). - You need to synchronize the same branch,
Xlocally on enterprise (ideally don't push yet). For example ifcommunityis added as a remote in your enterprise repo, you can do the following:
git fetch --all # this will fetch community/X
git checkout community/X
git checkout -b X # now you have X in your enterprise repo, which we refer to as enterprise/X
- You need to merge
enterprise-mastertoenterprise/X. Solve any conflicts( and make sure to remove any parts that should not be in enterprise even though it doesn't have a conflict), on enterprise repository:
git checkout enterprise-master
git pull # make sure enterprise-master in your local is up-to-date
git checkout X
git merge origin/enterprise-master # assuming origin is the remote of citus-enterprise
- You should push this to enterprise and open a PR so that the job on community will see this branch. Also this will trigger CI to verify changes are correct.
- You should get approval for the merge conflict changes on
enterprise/X, preferably from the same reviewer as they are familiar with the change. - You should rerun the
check-merge-to-enterprisecheck oncommunity/X. You can use re-run from failed option in circle CI. - You can now merge
community/Xtocommunity/master. - You can merge
enterprise/Xtoenterprise-master. - Manually merge
community mastertoenterprise-master. https://github.com/citusdata/citus-enterprise/blob/enterprise-master/CONTRIBUTING.md#merging-community-changes-onto-enterprise - You can use
git checkout --ours <conflicting file names>for all conflicting files. This will use local/our version to resolve the conflicts. - Now you can push to
enterprise-master. Now you can rerun the check oncommunity/masterand it should pass the check.
The subsequent PRs on community will be able to pass the check-merge-to-enterprise check as long as they don't have a conflict with enterprise-master.