mirror of
https://github.com/dorny/paths-filter.git
synced 2025-06-08 00:59:04 +00:00
5ee2f5d4cf
Declared the input parameter in the action.yml file so GitHub should no longer complain about invalid input when we use the new feature. Fixes #225 Signed-off-by: Peter Somogyvari <peter.somogyvari@accenture.com>
65 lines
3 KiB
YAML
65 lines
3 KiB
YAML
name: 'Paths Changes Filter'
|
|
description: 'Execute your workflow steps only if relevant files are modified.'
|
|
author: 'Michal Dorner <dorner.michal@gmail.com>'
|
|
inputs:
|
|
token:
|
|
description: 'GitHub Access Token'
|
|
required: false
|
|
default: ${{ github.token }}
|
|
working-directory:
|
|
description: 'Relative path under $GITHUB_WORKSPACE where the repository was checked out.'
|
|
required: false
|
|
ref:
|
|
description: |
|
|
Git reference (e.g. branch name) from which the changes will be detected.
|
|
This option is ignored if action is triggered by pull_request event.
|
|
required: false
|
|
base:
|
|
description: |
|
|
Git reference (e.g. branch name) against which the changes will be detected. Defaults to repository default branch (e.g. master).
|
|
If it references same branch it was pushed to, changes are detected against the most recent commit before the push.
|
|
This option is ignored if action is triggered by pull_request event.
|
|
required: false
|
|
filters:
|
|
description: 'Path to the configuration file or YAML string with filters definition'
|
|
required: true
|
|
list-files:
|
|
description: |
|
|
Enables listing of files matching the filter:
|
|
'none' - Disables listing of matching files (default).
|
|
'csv' - Coma separated list of filenames.
|
|
If needed it uses double quotes to wrap filename with unsafe characters.
|
|
'json' - Serialized as JSON array.
|
|
'shell' - Space delimited list usable as command line argument list in linux shell.
|
|
If needed it uses single or double quotes to wrap filename with unsafe characters.
|
|
'escape'- Space delimited list usable as command line argument list in linux shell.
|
|
Backslash escapes every potentially unsafe character.
|
|
required: false
|
|
default: none
|
|
initial-fetch-depth:
|
|
description: |
|
|
How many commits are initially fetched from base branch.
|
|
If needed, each subsequent fetch doubles the previously requested number of commits
|
|
until the merge-base is found or there are no more commits in the history.
|
|
This option takes effect only when changes are detected using git against different base branch.
|
|
required: false
|
|
default: '100'
|
|
predicate-quantifier:
|
|
description: |
|
|
Makes the pattern evaluation customizable when it comes to matching files:
|
|
'every'- When choosing 'every' in the config it means that files will only get matched if all the
|
|
patterns are satisfied by the path of the file, not just at least one of them.
|
|
'some' - When choosing 'some' in the config it means that files will get matched as long as there is
|
|
at least one pattern that matches them. This is the default behavior if you don't
|
|
specify anything as a predicate quantifier. (default)
|
|
required: false
|
|
default: some
|
|
outputs:
|
|
changes:
|
|
description: JSON array with names of all filters matching any of changed files
|
|
runs:
|
|
using: 'node20'
|
|
main: 'dist/index.js'
|
|
branding:
|
|
color: blue
|
|
icon: filter
|