github/azure-sdk-for-cpp
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

Improve matrix config include docs (#3801)

Browse Source 
Co-authored-by: Ben Broderick Phillips <bebroder@microsoft.com>
This commit is contained in:
Azure SDK Bot 2022-07-06 13:27:02 -07:00 committed by GitHub
parent 31ddec2076
commit 4a0e339563
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 36 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

49
eng/common/scripts/job-matrix/README.md
View File

@ -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