Update doc/common/matrix_generator.md: review and rewrite for clarity
#5023
Conversation
konrad-jamrozik
requested review from
sima-zhu,
weshaggard and
benbp
as code owners
|
The following pipelines have been queued for testing: |
konrad-jamrozik
added
Central-EngSys
|
The following pipelines have been queued for testing: |
|
The following pipelines have been queued for testing: |
konrad-jamrozik
force-pushed
the
users/kojamroz/iss_4995_pr1
branch
from
3ae3aa1
to
f778346
Compare
|
The following pipelines have been queued for testing: |
|
The following pipelines have been queued for testing: |
|
The following pipelines have been queued for testing: |
|
The following pipelines have been queued for testing: |
|
The following pipelines have been queued for testing: |
|
The following pipelines have been queued for testing: |
konrad-jamrozik
force-pushed
the
users/kojamroz/iss_4995_pr1
branch
from
fe603e2
to
2abce5c
Compare
|
The following pipelines have been queued for testing: |
konrad-jamrozik
force-pushed
the
users/kojamroz/iss_4995_pr1
branch
2 times, most recently
from
cc0c980
to
aa9084d
Compare
|
The following pipelines have been queued for testing: |
|
|
||
| Display name filters can also be passed as a single regex string that runs against the [generated display name](#displaynames) of the matrix job. | ||
| The intent of display name filters is to be defined primarily as a top level variable at template queue time in the azure pipelines UI. | ||
| Interpreting missing key in given combination as a key with value being empty string enables following scenarios: |
There was a problem hiding this comment.
I think the way this sentence is written is a little confusing.
There was a problem hiding this comment.
Thanks for pointing this out. Addressed! Please have a look: 13657fe :)
|
The following pipelines have been queued for testing: |
|
The following pipelines have been queued for testing: |
|
The following pipelines have been queued for testing: |
This PR contributes to addressing: - #4995 by moving out of `eng/common/scripts/job-matrix` assets that should not be mirrored to language repos. These assets include documentation, samples, and tests. ## Changes made - Moved contents of `eng/common/scripts/job-matrix/README.md` to newly introduced `doc/common/matrix_generator.md`; - Replaced contents of `eng/common/scripts/job-matrix/README.md` with a pointer to `doc/common/matrix_generator.md`; - Moved contents of `eng/common/scripts/job-matrix/scripts` and `eng/common/scripts/job-matrix/tests` to corresponding directories in newly introduced directory of `eng/common-tests/matrix-generator`. Note the introduced directory and doc file use `matrix generator` as name, not `job matrix`. This matches the terminology used in the documentation. ## Changes NOT made - The contents of files moved from `scripts` and `tests` directories have not been updated at all. The files have been moved unchanged. - The contents of the moved `README.md` have not been updated, even though they should, as they refer to paths that have changed as a result of the move. To keep the PR diff clean, I will instead update them in a separate PR: - #5023
konrad-jamrozik
force-pushed
the
users/kojamroz/iss_4995_pr1
branch
3 times, most recently
from
9ea174d
to
872121d
Compare
konrad-jamrozik
force-pushed
the
users/kojamroz/iss_4995_pr1
branch
from
872121d
to
79cdaee
Compare
konrad-jamrozik
changed the title
eng/common/scripts/job-matrix/README.mddoc\common\matrix_generator.md: review and rewrite for clarity
konrad-jamrozik
changed the title
doc\common\matrix_generator.md: review and rewrite for claritydoc/common/matrix_generator.md: review and rewrite for clarity
|
/check-enforcer override |
In preparation to address:
I was reading through the
job-matrix/README.mdand took the liberty to make some improvements.Changes made
eng/common#5027 is mergedMerging prerequisite
This PR cannot be merged until the following PR is merged:
eng/common#5027Once that PR is merged, this PR will be updated to modify the newly introduced
matrix_generator.mdinstead ofREADME.md.