actions/changed-files
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Tonye Jack 2023-06-16 18:57:56 -06:00 committed by GitHub
parent 77f9e6c7c6
commit 690b721958
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 32 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

60
README.md
View File

@ -19,7 +19,7 @@
## changed-files ## changed-files
Retrieve all changed files and directories relative to a target branch, preceding commit or the last remote commit returning **relative paths** from the project root. Effortlessly track all changed files and directories relative to a target branch, preceding commit or the last remote commit returning **relative paths** from the project root.
## Table of contents ## Table of contents
@ -39,33 +39,37 @@ Retrieve all changed files and directories relative to a target branch, precedin
## Features ## Features
* Fast execution (0-10 seconds on average). * Provides fast execution, averaging 0-10 seconds.
* Easy to debug. * Facilitates easy debugging.
* Scales to large repositories. * Scales to handle large repositories.
* Supports Git submodules. * Supports Git submodules.
* Escaped JSON output which can be used to run matrix jobs based on changed files. * Generates escaped JSON output for running matrix jobs based on changed files.
* List changed directories. * Lists changed directories.
* Limit the matching changed directories to a maximum depth. * Allows limiting the matching changed directories to a specified maximum depth.
* Optionally exclude the current directory * Optionally excludes the current directory.
* Write outputs to a `.txt` or `.json` file at a specified location for further processing. * Writes outputs to a designated `.txt` or `.json` file for further processing.
* Monorepos (Fetches a fixed number of commits). * Restores deleted files to their previous location or a new specified location for all deleted files.
* Supports all platforms (Linux, MacOS, Windows). * Supports Monorepos by fetching a fixed number of commits.
* [GitHub-hosted runners](https://docs.github.com/en/actions/using-github-hosted-runners/about-github-hosted-runners) support * Compatible with all platforms (Linux, MacOS, Windows).
* [GitHub Enterprise Server](https://docs.github.com/en/enterprise-server@3.3/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-github-actions-for-github-enterprise-server) support. * Supports [GitHub-hosted runners](https://docs.github.com/en/actions/using-github-hosted-runners/about-github-hosted-runners).
* [self-hosted runners](https://docs.github.com/en/actions/hosting-your-own-runners/about-self-hosted-runners) support. * Supports [GitHub Enterprise Server](https://docs.github.com/en/enterprise-server@3.3/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-github-actions-for-github-enterprise-server).
* List all files and directories that have changed: * Supports [self-hosted runners](https://docs.github.com/en/actions/hosting-your-own-runners/about-self-hosted-runners).
* Between the current pull request branch and the last commit on the target branch. * Lists all files and directories that have changed:
* Between the last commit and the current pushed change. * Between the current pull request branch and the last commit on the target branch.
* Between the last remote branch commit and the current HEAD. * Between the last commit and the current pushed change.
* Restrict change detection to a subset of files and directories: * Between the last remote branch commit and the current HEAD.
* Boolean output indicating that certain files have been changed. * Restricts change detection to a subset of files and directories:
* Using [Glob pattern](https://docs.github.com/en/actions/learn-github-actions/workflow-syntax-for-github-actions#filter-pattern-cheat-sheet) matching. * Provides boolean output indicating changes in specific files.
* Globstar. * Uses [Glob pattern](https://docs.github.com/en/actions/learn-github-actions/workflow-syntax-for-github-actions#filter-pattern-cheat-sheet) matching.
* Brace expansion. * Supports Globstar.
* Negation. * Supports brace expansion.
* Using [YAML](https://yaml.org/) syntax for specifying the patterns. * Supports negation.
* Supports [YAML anchors & aliases](https://www.educative.io/blog/advanced-yaml-syntax-cheatsheet#anchors). * Uses [YAML](https://yaml.org/) syntax for specifying patterns.
* Supports [YAML multi-line strings](https://learnxinyminutes.com/docs/yaml/). * Supports [YAML anchors & aliases](https://www.educative.io/blog/advanced-yaml-syntax-cheatsheet#anchors).
* Supports [YAML multi-line strings](https://learnxinyminutes.com/docs/yaml/).
And many more.
## Usage ## Usage