Skip to content

Commit cae9006

Browse files
docs: update outputs in readme to account for the 'every' predicate-quantifier (#247)
Co-authored-by: Sascha Bratton <sascha@queen.one>
1 parent 7b450ff commit cae9006

1 file changed

Lines changed: 8 additions & 4 deletions

File tree

README.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -187,10 +187,14 @@ For more information, see [CHANGELOG](https://github.com/dorny/paths-filter/blob
187187

188188
## Outputs
189189

190-
- For each filter, it sets output variable named by the filter to the text:
191-
- `'true'` - if **any** of changed files matches any of filter rules
192-
- `'false'` - if **none** of changed files matches any of filter rules
193-
- For each filter, it sets an output variable with the name `${FILTER_NAME}_count` to the count of matching files.
190+
- Each filter sets an output variable, named after the filter, whose text value depends on the `predicate-quantifier` setting:
191+
- With `predicate-quantifier: 'some'` (default):
192+
- `'true'` - if **any** changed file matches **at least one** of the filter's rules
193+
- `'false'` - if **no** changed file matches **at least one** of the filter's rules
194+
- With `predicate-quantifier: 'every'`:
195+
- `'true'` - if **any** changed file matches **all** of the filter's rules
196+
- `'false'` - if **no** changed file matches **all** of the filter's rules
197+
- Each filter sets an output variable with the name `${FILTER_NAME}_count` to the count of matching files.
194198
- If enabled, for each filter it sets an output variable with the name `${FILTER_NAME}_files`. It will contain a list of all files matching the filter.
195199
- `changes` - JSON array with names of all filters matching any of the changed files.
196200

0 commit comments

Comments
 (0)