From 144479700345fc4e88d6e7d45ea0739e9a48dfe9 Mon Sep 17 00:00:00 2001 From: ChristianKuehnel Date: Mon, 7 Feb 2022 09:57:51 +0100 Subject: [PATCH] Update monitoring_main_branch.md fixed formatting, spelled out the background/problem statement --- docs/monitoring_main_branch.md | 31 +++++++++++++++---------------- 1 file changed, 15 insertions(+), 16 deletions(-) diff --git a/docs/monitoring_main_branch.md b/docs/monitoring_main_branch.md index c20e3d6..877ba66 100644 --- a/docs/monitoring_main_branch.md +++ b/docs/monitoring_main_branch.md @@ -5,25 +5,24 @@ for use in pre-merge testing. ## Background -TODO explain background: - * Phab only has diffs, we need to apply these on a git base revision. - * Many of the base revisions are broken. - * pre-merge fails due to unrelated issues. - * goal: reduce % of broken revisions by getting them fixed faster - +The stability of the pre-merge testing largely depends on the stability of the +LLVM main branch: Whenever something is broken on the main branch, also +pre-merge testing will fail: The patches from Phabricator are applied to some +revision on the main branch before they can be built. So the fewer revisions of +the main branch being broken, the more stable pre-merge testing will be. ## High-level Design - We propose to run a Buildbot worker on the main branch with the same - Docker image we're using for pre-merge testing. That worker shall check all - commits to main for build and test failures with regards to the configuration - we're using for pre-merge testing. Whenever these builds fails, Buildbot - notifies the commiters and gives them the opportunity to fix or revert their - patch. +We propose to run a Buildbot worker on the main branch with the same +Docker image we're using for pre-merge testing. That worker shall check all +commits to main for build and test failures with regards to the configuration +we're using for pre-merge testing. Whenever these builds fails, Buildbot +notifies the commiters and gives them the opportunity to fix or revert their +patch. - This is much faster than a having a human investigate the issue and notify the - committers. By having faster feedback the main branch is broken for fewer - revisions and this the probability of a false-positive pre-merge test is lower. +This is much faster than a having a human investigate the issue and notify the +committers. By having faster feedback the main branch is broken for fewer +revisions and this the probability of a false-positive pre-merge test is lower. ## Machine setup @@ -72,4 +71,4 @@ usual](https://github.com/llvm/llvm-zorg/blob/main/buildbot/osuosl/master/config will not result in nice build steps as the other builders are producing as buildkite does not have that concept. Is that an issue? 4. We do need to check out the pre-merge testing config and scripts form another - git repo. Is that an issue? \ No newline at end of file + git repo. Is that an issue?