step-security/Paths Changes Filter
Execute your workflow steps only if relevant files are modified.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| token | GitHub Access Token | no | ${{ github.token }} |
| working-directory | Relative path under $GITHUB_WORKSPACE where the repository was checked out. | no | — |
| ref | 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. | no | — |
| base | 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. | no | — |
| filters | Path to the configuration file or YAML string with filters definition | yes | — |
| list-files | 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. | no | none |
| initial-fetch-depth | 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. | no | 100 |
| predicate-quantifier | allows to override the "at least one pattern" behavior to make it so that all of the patterns have to match or otherwise the file is excluded. | no | some |
Outputs
| name | description |
|---|---|
| changes | JSON array with names of all filters matching any of changed files |