dorny/paths-filter
Paths Filter
paths-filter is a GitHub Actions path filter and git change detector designed to trigger conditional workflow steps by identifying modified files. It serves as a path-based change metadata generator that determines if specific files or directories have changed to drive automation logic in CI pipelines.
The tool identifies modified files between commits or branches using configurable inclusion and exclusion filters. It exports boolean flags, modified filename lists, and file counts to allow downstream automation steps to execute only when specific criteria are met.
The project provides capabilities for change detection analysis, including the ability to filter by change type and path patterns. It supports metadata extraction for monorepo pipeline management and conditional deployment triggering.
Features
- Changed File Identification - Identifies modified, added, or deleted files relative to a specific version control revision to drive automation.
- Git Change Detectors - Provides a mechanism to identify modified files between git commits to drive conditional automation in CI pipelines.
- Change Metadata Generators - Generates boolean flags and lists of modified filenames to drive downstream CI/CD automation logic.
- Change-Based Path Filtering - Compares modified files in a commit or pull request against path rules to determine if criteria are met.
- File Pattern Matching - Provides utilities for matching modified file paths using wildcard and recursive glob patterns.
- Cross-Branch Change Detection - Compares current code against a base branch or commit to identify specifically modified files.
- Change Metadata Generators - Generates boolean flags and modified filename lists based on inclusion and exclusion filters to drive downstream automation.
- CI Change Analysis - Analyzes commit metadata to generate lists of modified files and counts for downstream pipeline logic.
- Trigger Condition Filters - Provides a mechanism to restrict GitHub Actions workflow execution based on whether files matching path patterns were updated.
- Conditional Execution Gating - Provides a mechanism to gate the execution of workflow steps based on which files were modified.
- GitHub Actions - Optimizes GitHub Actions workflows by running automation steps only when specific files are modified.
- Path Filters - Implements a path-based filter for GitHub Actions to trigger conditional job execution based on modified files.
- Git Diff Utilities - Uses git diff utilities to identify which files have changed between commits or branches.
- Execution State Exporters - Exports the final state of matching results and file counts to GitHub Actions output parameters.
- File Exclusion Patterns - Implements negative path patterns to ignore specific files or extensions during change detection.
- Monorepo Managers - Supports monorepo management by coordinating independent build and test processes based on changed paths.
- Path-Based - Triggers deployment of specific services or components only when changes are detected in their source folders.
- Filter Rule Schemas - Supports defining matching rules and exclusion patterns via a structured JSON schema.
- Workflow Utilities - Filter workflows by modified paths.
