From 4a0e33956396c8d691070d4c6e42c2e4678c9f57 Mon Sep 17 00:00:00 2001 From: Azure SDK Bot <53356347+azure-sdk@users.noreply.github.com> Date: Wed, 6 Jul 2022 13:27:02 -0700 Subject: [PATCH] Improve matrix config include docs (#3801) Co-authored-by: Ben Broderick Phillips --- eng/common/scripts/job-matrix/README.md | 49 ++++++++++++++++++------- 1 file changed, 36 insertions(+), 13 deletions(-) diff --git a/eng/common/scripts/job-matrix/README.md b/eng/common/scripts/job-matrix/README.md index d46efdd42..b9f540e42 100644 --- a/eng/common/scripts/job-matrix/README.md +++ b/eng/common/scripts/job-matrix/README.md @@ -120,26 +120,49 @@ Example: The `include` field defines any number of matrices to be appended to the base matrix after processing exclusions. -#### exclude - -The `include` field defines any number of matrices to be removed from the base matrix. Exclude parameters can be a partial -set, meaning as long as all exclude parameters match against a matrix entry (even if the matrix entry has additional parameters), -then it will be excluded from the matrix. For example, the below entry will match the exclusion and be removed: - ``` -matrix entry: +# matrix entry format: { "a": 1, "b": 2, "c": 3, } -"exclude": [ - { - "a": 1, - "b": 2 - } -] +# Include field in a matrix config +{ + "include": [ + { + "a": 1, + "b": 2 + } + ] +} +``` + + +#### exclude + +The `exclude` field defines any number of matrices to be removed from the base matrix. Exclude parameters can be a partial +set, meaning as long as all exclude parameters match against a matrix entry (even if the matrix entry has additional parameters), +then it will be excluded from the matrix. For example, the below entry will match the exclusion and be removed: + +``` +# matrix entry format: +{ + "a": 1, + "b": 2, + "c": 3, +} + +# Exclude field in a matrix config +{ + "exclude": [ + { + "a": 1, + "b": 2 + } + ] +} ``` #### displayNames