Branch Protection Using Buildbot
MariaDB uses branch protection to ensure that pushes to the MariaDB Server git repository cannot be made without first passing a series of tests. This page aims to describe what a developer should do in order to ensure that their changes get pushed to the main repository.
The current protected branches are: 10.2, 10.3, 10.4, 10.5
Protected Branches Flow
- Rebase your work on top of the latest main branch.
git rebase 10.2
- Push to bb-* branch
- Wait for all the checks to run
- If all checks are successful you can push to the main branch to be the same as bb-* branch
- If not (failed checks), check the build status, make changes accordingly and repeat this flow
Protected Branches Builders
The following are the only required builders at this point:
The protected branches builders run a subset of tests in order to avoid sporadic failures. The list is defined by:
All other checks are not required in order to make the push. However, please take a look at all the builders and look for failures.
Disabled Protected Branches
- ppc64le-rhel-8 (temporarily disabled, pending network bottleneck fix)
Viewing Build Status
The build status can be seen directly from GitHub near the commit message. Below, you can find an example (please note the yellow dot near the commit message):
If you click on the yellow dot, you can find the list of checks performed and their status, as shown below:
By clicking on Details you will be redirected to the buildbot page showing all the build details.
Alternatively, you can look for the builds on the buildbot Grid View. This allows filtering by branch, so to only see changes for one particular branch you can use https://buildbot.mariadb.org/#/grid?branch=10.5.
Status and Action Items
- Yellow dot - specifies that one or more of checks are not yet completed.
- Action item: Wait for all the checks to finish
- Green tick - all checks were successful
- Action item: No specific action is needed. The push can go through!
- Red X - one or more checks have failed
- Action item: Look at the status of failing builds and fix potential issues
Note: Only buildbot and not external CI tests (Travis, AppVeyor, etc) are currently in the protected branches criteria. Please take note of other failures, and if they are acceptable and explainable, then merge.
In some cases it might be useful to re-trigger one or more checks. This can easily be done from the https://buildbot.mariadb.org interface. The steps are:
- Login to https://buildbot.mariadb.org using the GitHub credentials: Hit the "Anonymous" button from the upper right corner and then "Login with GitHub" as shown below:
- Open the build details of the build you want to re-trigger
- Hit the "Rebuild" button from the upper right corner
Note: If you want to re-trigger all checks, the easiest approach is to make a new push. Alternatively, you can follow the above steps for all the checks