Skip to content

Commit 0601ec7

Browse files
Dan MoseleyjkotasCopilot
authored
Clarify wording for suppressing CI failure modes (#124681)
Updated wording for failure suppression suggestions in CI workflow documentation. --------- Co-authored-by: Jan Kotas <jkotas@microsoft.com> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
1 parent 07e1dcc commit 0601ec7

1 file changed

Lines changed: 2 additions & 2 deletions

File tree

docs/workflow/ci/failure-analysis.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -125,13 +125,13 @@ The reasons are captured by telemetry and regularly analyzed to allow us to find
125125
126126
The `Build Analysis` requests are sent to a queue. In certain scenarios, this queue can have many items to process and it can take a while for the status to be updated. If you do not see the status getting updated, be patient and wait at least 10 minutes before investigating further.
127127
128-
While most failures can be matched via known issues, a few failures modes cannot be matched currently and it is valid to suppress them manually. Suggested wording to use in these situations (this list is not exhaustive):
128+
While most failures can be matched via known issues, a few failure modes cannot be matched currently and it is valid to suppress them manually. Suggested wording to use in these situations (this list is not exhaustive, wording after `/ba-g` is an arbitrary justification string):
129129
130130
- `/ba-g deadletter` - Helix infrastructure failed with "This is a helix work item crash with status: DeadLetter." error message. Validate that the coverage provided by the dead-lettered leg is not relevant to the PR first. Rerun the leg instead if the coverage is relevant.
131131
- `/ba-g missing logs` - Logs are completely missing.
132132
- `/ba-g insufficient info in logs` - No good unique pattern in the logs to open a known issue.
133133
- `/ba-g recently fixed known issue #<Known Issue number>` - The fix for the known issue had already been merged, but the CI run was triggered beforehand.
134-
- `/ba-g all known issue filled #<Known Issue number 1>, #<Known Issue number 2>, ...` - All failures have known issues filled, but the build analysis is not turning green for some reasons.
134+
- `/ba-g all known issues already filed #<Known Issue number 1>, #<Known Issue number 2>, ...` - All failures have known issues filed, but the build analysis is not turning green for some reason.
135135
136136
On release branches, Build Analysis does not automatically turn green, even for known issues. Authors are required to use `/ba-g <reason>` to manually inspect the build analysis results and update its status as appropriate.
137137
For more information, see https://github.com/dotnet/arcade/blob/main/Documentation/Projects/Build%20Analysis/EscapeMechanismforBuildAnalysis.md

0 commit comments

Comments
 (0)