Enhance BuildRun states table:

Add new custom Reason valued when we have a Condition with a False Status.
shipwright-io · Mar 12, 2021 · 9b5c03b · 9b5c03b
1 parent cf769d5
commit 9b5c03b
Showing 1 changed file with 15 additions and 5 deletions.
diff --git a/docs/buildrun.md b/docs/buildrun.md
@@ -125,11 +125,21 @@ The following table illustrates the different states a BuildRun can have under i
 
 | Status | Reason | CompletionTime is set | Description |
 | --- | --- | --- | --- |
-| Unknown | Pending   | No  | The BuildRun is waiting on a Pod in status Pending. |
-| Unknown | Running   | No  | The BuildRun has been validate and started to perform its work. |
-| True    | Succeeded | Yes | The BuildRun Pod is done. |
-| False    | Failed | Yes | The BuildRun failed in one of the steps. |
-| False    | BuildRunTimeout | Yes | The BuildRun timed out. |
+| Unknown | Pending                       | No  | The BuildRun is waiting on a Pod in status Pending. |
+| Unknown | Running                       | No  | The BuildRun has been validate and started to perform its work. |
+| True    | Succeeded                     | Yes | The BuildRun Pod is done. |
+| False    | Failed                       | Yes | The BuildRun failed in one of the steps. |
+| False    | BuildRunTimeout              | Yes | The BuildRun timed out. |
+| False    | UnknownStrategyKind          | Yes | The Build specified strategy Kind is unknown. (_options: ClusterBuildStrategy or BuildStrategy_) |
+| False    | StrategyKindIsMissing        | Yes | The Build strategy Kind was not specified. (_options: ClusterBuildStrategy or BuildStrategy_) |
+| False    | ClusterBuildStrategyNotFound | Yes | The referenced cluster strategy was not found in the cluster. |
+| False    | BuildStrategyNotFound        | Yes | The referenced namespaced strategy was not found in the cluster. |
+| False    | SetOwnerReferenceFailed      | Yes | Setting ownerreferences from the BuildRun to the related TaskRun failed.  |
+| False    | TaskRunIsMissing             | Yes | The BuildRun related TaskRun was not found. |
+| False    | TaskRunGenerationFailed      | Yes | The generation of a TaskRun spec failed. |
+| False    | ServiceAccountNotFound       | Yes | The referenced service account was not found in the cluster. |
+| False    | BuildRegistrationFailed      | Yes | The related Build in the BuildRun is on a Failed state. |
+| False    | BuildNotFound                | Yes | The related Build in the BuildRun was not found. |
 
 _Note_: We heavily rely on the Tekton TaskRun [Conditions](https://github.com/tektoncd/pipeline/blob/master/docs/taskruns.md#monitoring-execution-status) for populating the BuildRun ones, with some exceptions.