docs(workflow): say ErrTooManyConfigurations does not cover the product cap
- commit
- ab2c1f40647312840f5dbe01a6ab75d0a88e0007
- author
- brice · · 2026-10-13 00:20 UTC
- committer
- brice · · 2026-10-18 14:59 UTC
- parent
- 7ce70de
- signature
- GPG Verified
CD88F9E564E0102646FB6077A1A07C7C7C3E349D· arch-gpg Verified for the committer email
1 file · +3 -1
M workflow/matrix.go +3 -1
| @@ -165,7 +165,9 @@ var errProductTooBig = fmt.Errorf("matrix too large: the cross product of the ve | |||
| 165 | 165 | // ErrTooManyConfigurations is matched, with [errors.Is], by the error that | |
| 166 | 166 | // [ExpandMatrix], [ParseStrategy] and [Job.EvaluateStrategy] return when a | |
| 167 | 167 | // matrix produces more than [MaxMatrixJobs] configurations. The error itself | |
| 168 | - | // carries the job and the count in its text. | |
| 168 | + | // carries the job and the count in its text. It does not match the error for a | |
| 169 | + | // cross product over [MaxMatrixProduct], which is a work bound of this package | |
| 170 | + | // rather than a GitHub rule. | |
| 169 | 171 | var ErrTooManyConfigurations = errors.New("matrix produces too many configurations") | |
| 170 | 172 | ||
| 171 | 173 | // configurationLimitError is returned when a matrix produces more than | |
| @@ -165,7 +165,9 @@ var errProductTooBig = fmt.Errorf("matrix too large: the cross product of the ve | |||||
| 165 | // ErrTooManyConfigurations is matched, with [errors.Is], by the error that | 165 | // ErrTooManyConfigurations is matched, with [errors.Is], by the error that | ||
| 166 | // [ExpandMatrix], [ParseStrategy] and [Job.EvaluateStrategy] return when a | 166 | // [ExpandMatrix], [ParseStrategy] and [Job.EvaluateStrategy] return when a | ||
| 167 | // matrix produces more than [MaxMatrixJobs] configurations. The error itself | 167 | // matrix produces more than [MaxMatrixJobs] configurations. The error itself | ||
| 168 | - | // carries the job and the count in its text. | 168 | + | // carries the job and the count in its text. It does not match the error for a |
| 169 | + | // cross product over [MaxMatrixProduct], which is a work bound of this package | |||
| 170 | + | // rather than a GitHub rule. | |||
| 169 | var ErrTooManyConfigurations = errors.New("matrix produces too many configurations") | 171 | var ErrTooManyConfigurations = errors.New("matrix produces too many configurations") | ||
| 170 | 172 | ||||
| 171 | // configurationLimitError is returned when a matrix produces more than | 173 | // configurationLimitError is returned when a matrix produces more than | ||