Skip to content

Commit

Permalink
add a note about usage in the readme
Browse files Browse the repository at this point in the history
  • Loading branch information
scbedd committed Mar 15, 2022
1 parent 7d950ab commit f8d8a70
Showing 1 changed file with 24 additions and 18 deletions.
42 changes: 24 additions & 18 deletions eng/common/scripts/job-matrix/README.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,25 @@
# Azure Pipelines Matrix Generator

* [Usage in a pipeline](#usage-in-a-pipeline)
* [Matrix config file syntax](#matrix-config-file-syntax)
* [Fields](#fields)
* [matrix](#matrix)
* [include](#include)
* [exclude](#exclude)
* [displayNames](#displaynames)
* [$IMPORT](#import)
* [Matrix Generation behavior](#matrix-generation-behavior)
* [all](#all)
* [sparse](#sparse)
* [include/exclude](#includeexclude)
* [displayNames](#displaynames-1)
* [Filters](#filters)
* [Replace/Modify/Append](#replacemodifyappend-values)
* [NonSparseParameters](#nonsparseparameters)
* [Under the hood](#under-the-hood)
* [Testing](#testing)
- [Azure Pipelines Matrix Generator](#azure-pipelines-matrix-generator)
- [Usage in a pipeline](#usage-in-a-pipeline)
- [A note regarding PreGenerationSteps](#a-note-regarding-pregenerationsteps)
- [Matrix config file syntax](#matrix-config-file-syntax)
- [Fields](#fields)
- [matrix](#matrix)
- [include](#include)
- [exclude](#exclude)
- [displayNames](#displaynames)
- [$IMPORT](#import)
- [Matrix Generation behavior](#matrix-generation-behavior)
- [all](#all)
- [sparse](#sparse)
- [include/exclude](#includeexclude)
- [displayNames](#displaynames-1)
- [Filters](#filters)
- [Replace/Modify/Append Values](#replacemodifyappend-values)
- [NonSparseParameters](#nonsparseparameters)
- [Under the hood](#under-the-hood)
- [Testing](#testing)


This directory contains scripts supporting dynamic, cross-product matrix generation for azure pipeline jobs.
Expand Down Expand Up @@ -59,6 +61,10 @@ jobs:
PreGenerationSteps: []
```

### A note regarding PreGenerationSteps

The generation template laid out above runs as its own job. A limitation of this method is that it disallows any runtime matrix customization due to the fact that an individual job clones the targeted build SHA. The stepList `PreGenerationSteps` allows users to update matrix json however they like prior to actually invoking the matrix generation. Injected steps are run after the repository checkout, but before any matrix generation is invoked.

## Matrix config file syntax

Matrix parameters can either be a list of strings, or a set of grouped strings (represented as a hash). The latter parameter
Expand Down

0 comments on commit f8d8a70

Please sign in to comment.