2023-02-16 00:55:26 +00:00
[![Ubuntu ](https://img.shields.io/badge/Ubuntu-E95420?style=for-the-badge\&logo=ubuntu\&logoColor=white )](https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions#jobsjob_idruns-on)
[![Mac OS ](https://img.shields.io/badge/mac%20os-000000?style=for-the-badge\&logo=macos\&logoColor=F0F0F0 )](https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions#jobsjob_idruns-on)
[![Windows ](https://img.shields.io/badge/Windows-0078D6?style=for-the-badge\&logo=windows\&logoColor=white )](https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions#jobsjob_idruns-on)
2024-03-07 04:25:13 +00:00
[![Public workflows that use this action. ](https://img.shields.io/endpoint?style=for-the-badge\&url=https%3A%2F%2Fused-by.vercel.app%2Fapi%2Fgithub-actions%2Fused-by%3Faction%3Dtj-actions%2Fchanged-files%26package_id%3DUGFja2FnZS0yOTQyNTU4MDk5%26badge%3Dtrue )](https://github.com/search?o=desc\&q=tj-actions+changed-files+language%3AYAML\&s=\&type=Code)
2023-02-16 00:54:23 +00:00
2024-01-07 13:40:56 +00:00
[![Codacy Badge ](https://app.codacy.com/project/badge/Grade/4fe2f49c3ab144b0bbe4effc85a061a0 )](https://app.codacy.com/gh/tj-actions/changed-files/dashboard?utm_source=gh\&utm_medium=referral\&utm_content=\&utm_campaign=Badge_grade)
2023-09-23 00:06:26 +00:00
[![CI ](https://github.com/tj-actions/changed-files/actions/workflows/test.yml/badge.svg )](https://github.com/tj-actions/changed-files/actions/workflows/test.yml)
2023-09-22 23:55:18 +00:00
[![Update release version. ](https://github.com/tj-actions/changed-files/actions/workflows/sync-release-version.yml/badge.svg )](https://github.com/tj-actions/changed-files/actions/workflows/sync-release-version.yml)
2021-07-18 01:27:50 +00:00
2021-06-09 23:07:22 +00:00
<!-- ALL - CONTRIBUTORS - BADGE:START - Do not remove or modify this section -->
2024-02-17 22:32:19 +00:00
2024-02-17 22:31:24 +00:00
[![All Contributors ](https://img.shields.io/badge/all_contributors-26-orange.svg?style=flat-square )](#contributors-)
2024-02-17 22:32:19 +00:00
2021-06-09 23:07:22 +00:00
<!-- ALL - CONTRIBUTORS - BADGE:END -->
2021-03-11 00:59:05 +00:00
2021-06-09 15:55:30 +00:00
## changed-files
2021-03-05 02:36:52 +00:00
2024-02-02 12:26:23 +00:00
Effortlessly track all changed files and directories relative to a target branch, the current branch (preceding commit or the last remote commit), multiple branches, or custom commits returning **relative paths** from the project root using this GitHub action.
2022-08-17 19:33:07 +00:00
2023-11-28 18:23:42 +00:00
> \[!NOTE]
2023-09-25 05:39:22 +00:00
>
2024-02-21 14:20:22 +00:00
> * This action solely identifies files that have changed for events such as [`pull_request*`, `push`, `merge_group`, `release`, and many more](#other-supported-events-electron). However, it doesn't detect pending uncommitted changes created during the workflow execution.
2023-09-25 05:39:22 +00:00
>
2023-09-26 15:53:45 +00:00
> See: https://github.com/tj-actions/verify-changed-files instead
2023-09-25 05:39:22 +00:00
2023-03-14 16:25:49 +00:00
## Table of contents
2023-08-30 17:41:36 +00:00
* [Features 🚀 ](#features- )
* [Usage 💻 ](#usage- )
2023-08-30 21:09:09 +00:00
* [On `pull_request` 🔀 ](#on-pull_request- )
2024-02-05 05:03:52 +00:00
* [Using local .git directory 📁 ](#using-local-git-directory- )
2023-08-30 17:41:36 +00:00
* [Using Github's API :octocat: ](#using-githubs-api-octocat )
* [On `push` ⬆️ ](#on-push-️ )
2023-10-26 20:45:16 +00:00
* [Other supported events :electron: ](#other-supported-events-electron )
2023-08-30 17:41:36 +00:00
* [Inputs ⚙️ ](#inputs-️ )
2023-11-27 17:57:48 +00:00
* [Useful Acronyms 🧮 ](#useful-acronyms- )
2023-12-03 21:16:56 +00:00
* [Outputs 📤 ](#outputs- )
2023-08-30 17:41:36 +00:00
* [Versioning 🏷️ ](#versioning-️ )
* [Examples 📄 ](#examples- )
* [Real-world usage 🌐 ](#real-world-usage- )
* [Open source projects 📦 ](#open-source-projects- )
* [Scalability Example 📈 ](#scalability-example- )
2023-10-07 18:00:52 +00:00
* [Important Notice ⚠️ ](#important-notice-️ )
2023-08-30 17:41:36 +00:00
* [Migration guide 🔄 ](#migration-guide- )
* [Credits 👏 ](#credits- )
* [Report Bugs 🐛 ](#report-bugs- )
2023-03-14 16:35:51 +00:00
* [Contributors ✨ ](#contributors- )
2023-08-30 17:23:44 +00:00
## Features 🚀
2021-06-23 13:34:52 +00:00
2023-07-11 03:39:12 +00:00
* Fast execution, averaging 0-10 seconds.
2023-06-23 17:20:13 +00:00
* Leverages either [Github's REST API ](https://docs.github.com/en/rest/reference/repos#list-commits ) or [Git's native diff ](https://git-scm.com/docs/git-diff ) to determine changed files.
2023-06-17 01:40:34 +00:00
* Facilitates easy debugging.
2023-12-10 07:28:33 +00:00
* Scales to handle large/mono repositories.
2023-06-17 01:40:34 +00:00
* Supports Git submodules.
2023-08-08 16:15:34 +00:00
* Supports [merge queues ](https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-a-merge-queue ) for pull requests.
2024-01-28 20:02:05 +00:00
* Generates escaped [JSON output for running matrix jobs ](https://github.com/tj-actions/changed-files/blob/main/.github/workflows/matrix-example.yml ) based on changed files.
2023-06-17 01:40:34 +00:00
* Lists changed directories.
2023-07-11 03:40:47 +00:00
* Limits matching changed directories to a specified maximum depth.
2023-06-17 01:40:34 +00:00
* Optionally excludes the current directory.
* Writes outputs to a designated `.txt` or `.json` file for further processing.
* Restores deleted files to their previous location or a newly specified location.
2023-12-10 07:28:33 +00:00
* Supports fetching a fixed number of commits which improves performance.
2023-06-17 01:40:34 +00:00
* Compatible with all platforms (Linux, MacOS, Windows).
* Supports [GitHub-hosted runners ](https://docs.github.com/en/actions/using-github-hosted-runners/about-github-hosted-runners ).
* 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 ).
* Supports [self-hosted runners ](https://docs.github.com/en/actions/hosting-your-own-runners/about-self-hosted-runners ).
* Lists all files and directories that have changed:
* Between the current pull request branch and the last commit on the target branch.
* Between the last commit and the current pushed change.
* Between the last remote branch commit and the current HEAD.
* Restricts change detection to a subset of files and directories:
* Provides boolean output indicating changes in specific files.
2023-08-03 19:24:56 +00:00
* Uses [Glob pattern ](https://codepen.io/mrmlnc/pen/OXQjMe ) matching.
2023-06-17 01:40:34 +00:00
* Supports Globstar.
* Supports brace expansion.
* Supports negation.
* Uses [YAML ](https://yaml.org/ ) syntax for specifying patterns.
2023-09-14 17:38:21 +00:00
* Supports [YAML anchors & aliases ](https://github.com/tj-actions/changed-files/blob/main/test/changed-files.yml#L8-L12 ).
* Supports [YAML multi-line strings ](https://github.com/tj-actions/changed-files/blob/main/test/changed-files.yml#L13-L16 ).
2023-06-17 00:57:56 +00:00
2023-08-05 05:50:03 +00:00
And many more...
2023-06-17 00:57:56 +00:00
2023-08-30 17:23:44 +00:00
## Usage 💻
2021-05-04 17:53:26 +00:00
2023-11-28 18:23:42 +00:00
> \[!IMPORTANT]
2023-07-25 23:05:08 +00:00
>
2023-10-27 04:34:26 +00:00
> * **Push Events**: When configuring [`actions/checkout`](https://github.com/actions/checkout#usage), make sure to set [`fetch-depth`](https://github.com/actions/checkout#usage) to either `0` or `2`, depending on your use case.
2023-10-27 04:36:00 +00:00
> * **Mono Repositories**: To avoid pulling the entire branch history, you can utilize the default [`actions/checkout`](https://github.com/actions/checkout#usage)'s [`fetch-depth`](https://github.com/actions/checkout#usage) of `1` for [`pull_request`](https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#pull_request) events.
2023-10-27 17:24:18 +00:00
> * **Quoting Multiline Inputs**: Avoid using single or double quotes for [multiline](https://github.com/tj-actions/changed-files/blob/main/test/changed-files.yml#L13-L16) inputs. The value is already a string separated by a newline character. Refer to the [Examples](#examples-) section for more information.
2023-10-27 04:34:26 +00:00
> * **Credentials Persistence**: If [`fetch-depth`](https://github.com/actions/checkout#usage) is not set to 0, make sure to set [`persist-credentials`](https://github.com/actions/checkout#usage) to `true` when configuring [`actions/checkout`](https://github.com/actions/checkout#usage).
> * **Matching Files and Folders**: To match all files and folders under a directory, this requires a globstar pattern e.g. `dir_name/**` which matches any number of subdirectories and files.
2023-07-25 23:05:08 +00:00
Visit the [discussions for more information ](https://github.com/tj-actions/changed-files/discussions ) or [create a new discussion ](https://github.com/tj-actions/changed-files/discussions/new/choose ) for usage-related questions.
2023-10-26 20:44:18 +00:00
### On [`pull_request`](https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#pull_request) 🔀
2023-09-15 04:07:53 +00:00
2023-09-15 03:59:38 +00:00
Detect changes to all files in a Pull request relative to the target branch or since the last pushed commit.
2023-06-29 01:29:52 +00:00
2024-02-05 04:55:53 +00:00
#### Using local .git directory 📁
2023-07-10 20:25:04 +00:00
2021-05-04 17:53:26 +00:00
```yaml
name: CI
on:
pull_request:
branches:
- main
2023-03-29 17:09:03 +00:00
2021-05-04 17:53:26 +00:00
jobs:
2023-07-09 08:54:05 +00:00
# ------------------------------------------------------------------------------------------------------------------------------------------------
# Event `pull_request` : Compare the last commit of the main branch or last remote commit of the PR branch -> to the current commit of a PR branch.
# ------------------------------------------------------------------------------------------------------------------------------------------------
2023-07-10 20:25:04 +00:00
changed_files:
2023-07-13 00:03:18 +00:00
runs-on: ubuntu-latest # windows-latest || macos-latest
2021-05-04 17:53:26 +00:00
name: Test changed-files
steps:
2023-09-04 20:42:58 +00:00
- uses: actions/checkout@v4
2021-05-04 17:53:26 +00:00
with:
fetch-depth: 0 # OR "2" -> To retrieve the preceding commit.
2022-10-21 14:44:19 +00:00
2024-02-05 19:34:02 +00:00
# -----------------------------------------------------------------------------------------------------------
2023-06-28 07:28:09 +00:00
# Example 1
2024-02-05 19:34:02 +00:00
# -----------------------------------------------------------------------------------------------------------
2023-10-04 01:17:20 +00:00
- name: Get changed files
id: changed-files
2024-03-13 23:06:28 +00:00
uses: tj-actions/changed-files@v43
2023-10-04 01:17:20 +00:00
# To compare changes between the current commit and the last pushed remote commit set `since_last_remote_commit: true` . e.g
# with:
# since_last_remote_commit: true
- name: List all changed files
2023-12-22 21:07:32 +00:00
env:
2023-12-23 11:50:22 +00:00
ALL_CHANGED_FILES: ${{ steps.changed-files.outputs.all_changed_files }}
2023-10-04 01:17:20 +00:00
run: |
2024-02-02 13:21:28 +00:00
for file in ${ALL_CHANGED_FILES}; do
2023-10-04 01:17:20 +00:00
echo "$file was changed"
done
2024-02-05 19:34:02 +00:00
# -----------------------------------------------------------------------------------------------------------
2023-10-04 01:17:20 +00:00
# Example 2
2024-02-05 19:34:02 +00:00
# -----------------------------------------------------------------------------------------------------------
2023-10-28 15:35:56 +00:00
- name: Get all changed markdown files
id: changed-markdown-files
2024-03-13 23:06:28 +00:00
uses: tj-actions/changed-files@v43
2023-10-28 15:34:36 +00:00
with:
2023-12-05 19:58:01 +00:00
# Avoid using single or double quotes for multiline patterns
2023-10-28 15:34:36 +00:00
files: |
2023-10-29 04:42:46 +00:00
** .md
2023-10-28 15:34:36 +00:00
- name: List all changed files markdown files
2023-12-05 19:58:01 +00:00
if: steps.changed-markdown-files.outputs.any_changed == 'true'
2023-12-22 21:07:32 +00:00
env:
2023-12-23 11:50:22 +00:00
ALL_CHANGED_FILES: ${{ steps.changed-markdown-files.outputs.all_changed_files }}
2023-10-28 15:34:36 +00:00
run: |
2024-02-02 13:21:28 +00:00
for file in ${ALL_CHANGED_FILES}; do
2023-10-28 15:34:36 +00:00
echo "$file was changed"
done
2024-02-05 19:34:02 +00:00
# -----------------------------------------------------------------------------------------------------------
2023-10-28 15:34:36 +00:00
# Example 3
2024-02-05 19:34:02 +00:00
# -----------------------------------------------------------------------------------------------------------
2023-06-16 07:37:49 +00:00
- name: Get all test, doc and src files that have changed
2023-06-22 05:59:37 +00:00
id: changed-files-yaml
2024-03-13 23:06:28 +00:00
uses: tj-actions/changed-files@v43
2023-06-16 06:17:13 +00:00
with:
files_yaml: |
doc:
2023-10-29 04:42:46 +00:00
- '**.md'
2023-07-21 00:20:09 +00:00
- docs/**
2023-06-16 06:17:13 +00:00
test:
2023-07-21 00:20:09 +00:00
- test/**
- '!test/**.md'
2023-06-16 06:17:13 +00:00
src:
2023-07-21 00:20:09 +00:00
- src/**
2023-06-16 06:17:13 +00:00
# Optionally set `files_yaml_from_source_file` to read the YAML from a file. e.g `files_yaml_from_source_file: .github/changed-files.yml`
- name: Run step if test file(s) change
2023-08-17 01:09:51 +00:00
# NOTE: Ensure all outputs are prefixed by the same key used above e.g. `test_(...)` | `doc_(...)` | `src_(...)` when trying to access the `any_changed` output.
2023-07-26 17:13:06 +00:00
if: steps.changed-files-yaml.outputs.test_any_changed == 'true'
2023-12-22 21:07:32 +00:00
env:
2023-12-23 11:50:22 +00:00
TEST_ALL_CHANGED_FILES: ${{ steps.changed-files-yaml.outputs.test_all_changed_files }}
2023-06-16 06:17:13 +00:00
run: |
echo "One or more test file(s) has changed."
2023-12-22 21:07:32 +00:00
echo "List all the files that have changed: $TEST_ALL_CHANGED_FILES"
2023-06-16 06:17:13 +00:00
- name: Run step if doc file(s) change
2023-06-22 05:59:37 +00:00
if: steps.changed-files-yaml.outputs.doc_any_changed == 'true'
2023-12-22 21:07:32 +00:00
env:
2023-12-23 11:50:22 +00:00
DOC_ALL_CHANGED_FILES: ${{ steps.changed-files-yaml.outputs.doc_all_changed_files }}
2023-06-16 06:17:13 +00:00
run: |
echo "One or more doc file(s) has changed."
2023-12-22 21:07:32 +00:00
echo "List all the files that have changed: $DOC_ALL_CHANGED_FILES"
2023-07-20 12:48:41 +00:00
2024-02-05 19:34:02 +00:00
# -----------------------------------------------------------------------------------------------------------
# Example 4
# -----------------------------------------------------------------------------------------------------------
2023-07-20 12:48:41 +00:00
- name: Get changed files in the docs folder
id: changed-files-specific
2024-03-13 23:06:28 +00:00
uses: tj-actions/changed-files@v43
2023-07-20 12:48:41 +00:00
with:
2023-10-26 03:35:54 +00:00
files: docs/*.{js,html} # Alternatively using: `docs/**`
2023-07-20 12:48:41 +00:00
files_ignore: docs/static.js
- name: Run step if any file(s) in the docs folder change
if: steps.changed-files-specific.outputs.any_changed == 'true'
2023-12-22 21:07:32 +00:00
env:
2023-12-23 11:50:22 +00:00
ALL_CHANGED_FILES: ${{ steps.changed-files-specific.outputs.all_changed_files }}
2023-07-20 12:48:41 +00:00
run: |
echo "One or more files in the docs folder has changed."
2023-12-22 21:07:32 +00:00
echo "List all the files that have changed: $ALL_CHANGED_FILES"
2021-05-04 17:53:26 +00:00
```
2023-08-30 17:23:44 +00:00
#### Using Github's API :octocat:
2023-07-10 20:25:04 +00:00
```yaml
name: CI
on:
pull_request:
branches:
- main
jobs:
# -------------------------------------------------------------
# Event `pull_request` : Returns all changed pull request files.
# --------------------------------------------------------------
changed_files:
# NOTE:
# - This is limited to pull_request* events and would raise an error for other events.
# - A maximum of 3000 files can be returned.
2023-07-12 22:30:41 +00:00
# - For more flexibility and no limitations see "Using local .git history" above.
2023-07-10 20:25:04 +00:00
2023-07-13 00:03:18 +00:00
runs-on: ubuntu-latest # windows-latest || macos-latest
2023-07-10 20:25:04 +00:00
name: Test changed-files
permissions:
pull-requests: read
steps:
- name: Get changed files
id: changed-files
2024-03-13 23:06:28 +00:00
uses: tj-actions/changed-files@v43
2023-07-10 20:25:04 +00:00
- name: List all changed files
2023-12-22 21:07:32 +00:00
env:
2023-12-23 11:52:19 +00:00
ALL_CHANGED_FILES: ${{ steps.changed-files.outputs.all_changed_files }}
2023-07-10 20:25:04 +00:00
run: |
2024-02-02 13:21:28 +00:00
for file in ${ALL_CHANGED_FILES}; do
2023-07-10 20:25:04 +00:00
echo "$file was changed"
done
```
2023-10-26 20:44:18 +00:00
### On [`push`](https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#push) ⬆️
2023-09-15 04:07:53 +00:00
2023-09-15 03:58:35 +00:00
Detect changes to files made since the last pushed commit.
2023-06-29 01:29:52 +00:00
```yaml
name: CI
on:
push:
branches:
- main
jobs:
# -------------------------------------------------------------
# Using GitHub's API is not supported for push events
# -------------------------------------------------------------
#
# ----------------------------------------------------------------------------------------------
2023-07-10 02:31:01 +00:00
# Using local .git history
2023-06-29 01:29:52 +00:00
# ----------------------------------------------------------------------------------------------
# Event `push` : Compare the preceding remote commit -> to the current commit of the main branch
# ----------------------------------------------------------------------------------------------
2023-07-13 00:03:18 +00:00
changed_files:
runs-on: ubuntu-latest # windows-latest || macos-latest
2023-06-29 01:29:52 +00:00
name: Test changed-files
steps:
2023-09-04 20:42:58 +00:00
- uses: actions/checkout@v4
2023-06-29 01:29:52 +00:00
with:
fetch-depth: 0 # OR "2" -> To retrieve the preceding commit.
- name: Get changed files
id: changed-files
2024-03-13 23:06:28 +00:00
uses: tj-actions/changed-files@v43
2023-06-29 01:29:52 +00:00
# NOTE: `since_last_remote_commit: true` is implied by default and falls back to the previous local commit.
- name: List all changed files
2023-12-22 21:07:32 +00:00
env:
2023-12-23 11:52:19 +00:00
ALL_CHANGED_FILES: ${{ steps.changed-files.outputs.all_changed_files }}
2023-06-29 01:29:52 +00:00
run: |
2024-02-02 13:21:28 +00:00
for file in ${ALL_CHANGED_FILES}; do
2023-06-29 01:29:52 +00:00
echo "$file was changed"
done
...
```
2023-10-26 20:44:18 +00:00
### Other supported events :electron:
2023-10-26 20:45:16 +00:00
* [schedule ](https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#schedule )
* [release ](https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#release )
* [workflow\_dispatch ](https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#workflow_dispatch )
2024-02-07 03:33:25 +00:00
* [workflow\_run ](https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#workflow_run )
2023-10-26 20:45:16 +00:00
* [merge\_group ](https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#merge_group )
* [issue\_comment ](https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#issue_comment )
* ...and many more
2023-10-26 20:44:18 +00:00
2023-09-28 17:37:08 +00:00
To access more examples, navigate to the [Examples ](#examples- ) section.
2023-05-28 22:58:50 +00:00
2021-11-24 19:04:39 +00:00
If you feel generous and want to show some extra appreciation:
Support this project with a :star:
[![Buy me a coffee][buymeacoffee-shield]][buymeacoffee]
[buymeacoffee]: https://www.buymeacoffee.com/jackton1
[buymeacoffee-shield]: https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png
2023-12-14 21:57:20 +00:00
> \[!IMPORTANT]
>
> * When using `files_yaml*` inputs:
> * All keys must start with a letter or `_` and contain only alphanumeric characters, `-`, or `_`.
2024-02-05 19:38:05 +00:00
>
> For example, `test` or `test_key` or `test-key` or `_test_key` are all valid.
2023-12-14 21:57:20 +00:00
2023-08-30 17:23:44 +00:00
## Inputs ⚙️
2021-04-24 08:49:18 +00:00
2022-10-29 21:48:36 +00:00
<!-- AUTO - DOC - INPUT:START - Do not remove or modify this section -->
2023-11-15 05:46:02 +00:00
```yaml
2024-03-13 23:06:28 +00:00
- uses: tj-actions/changed-files@v43
2023-11-15 05:46:02 +00:00
id: changed-files
with:
# Github API URL.
2023-11-20 02:16:46 +00:00
# Type: string
2023-11-16 15:14:50 +00:00
# Default: "${{ github.api_url }}"
2023-11-15 05:46:02 +00:00
api_url: ''
# Specify a different base commit SHA or branch used
# for comparing changes
2023-11-20 02:16:46 +00:00
# Type: string
2023-11-15 05:46:02 +00:00
base_sha: ''
# Exclude changes outside the current directory and show path
2023-11-15 19:50:40 +00:00
# names relative to it. NOTE: This requires you to
2023-11-15 15:49:57 +00:00
# specify the top-level directory via the `path` input.
2023-11-20 02:16:46 +00:00
# Type: boolean
2023-11-16 15:14:50 +00:00
# Default: "true"
2023-11-15 05:46:02 +00:00
diff_relative: ''
2023-11-15 19:50:40 +00:00
# Output unique changed directories instead of filenames. NOTE: This
2023-11-15 05:46:02 +00:00
# returns `.` for changed files located in the current
# working directory which defaults to `$GITHUB_WORKSPACE` .
2023-11-20 02:16:46 +00:00
# Type: boolean
2023-11-16 15:14:50 +00:00
# Default: "false"
2023-11-15 05:46:02 +00:00
dir_names: ''
# Include only directories that have been deleted as opposed
# to directory names of files that have been deleted
# in the `deleted_files` output when `dir_names` is set to
# `true` .
2023-11-20 02:16:46 +00:00
# Type: boolean
2023-11-16 15:14:50 +00:00
# Default: "false"
2023-11-15 05:46:02 +00:00
dir_names_deleted_files_include_only_deleted_dirs: ''
# Exclude the current directory represented by `.` from the
# output when `dir_names` is set to `true` .
2023-11-20 02:16:46 +00:00
# Type: boolean
2023-11-16 15:14:50 +00:00
# Default: "false"
2023-11-15 05:46:02 +00:00
dir_names_exclude_current_dir: ''
# File and directory patterns to include in the output
2023-11-15 19:50:40 +00:00
# when `dir_names` is set to `true` . NOTE: This returns
2023-11-15 05:46:02 +00:00
# only the matching files and also the directory names.
2023-11-20 02:16:46 +00:00
# Type: string
2023-11-15 05:46:02 +00:00
dir_names_include_files: ''
# Separator used to split the `dir_names_include_files` input
2023-11-20 02:16:46 +00:00
# Type: string
2023-11-16 15:14:50 +00:00
# Default: "\n"
2023-11-15 05:46:02 +00:00
dir_names_include_files_separator: ''
# Limit the directory output to a maximum depth e.g
# `test/test1/test2` with max depth of `2` returns `test/test1` .
2023-11-20 02:16:46 +00:00
# Type: string
2023-11-15 05:46:02 +00:00
dir_names_max_depth: ''
# Escape JSON output.
2023-11-20 02:16:46 +00:00
# Type: boolean
2023-11-16 15:14:50 +00:00
# Default: "true"
2023-11-15 05:46:02 +00:00
escape_json: ''
# Fail when the initial diff fails.
2023-11-20 02:16:46 +00:00
# Type: boolean
2023-11-16 15:14:50 +00:00
# Default: "false"
2023-11-15 05:46:02 +00:00
fail_on_initial_diff_error: ''
# Fail when the submodule diff fails.
2023-11-20 02:16:46 +00:00
# Type: boolean
2023-11-16 15:14:50 +00:00
# Default: "false"
2023-11-15 05:46:02 +00:00
fail_on_submodule_diff_error: ''
# Fetch additional history for submodules.
2023-11-20 02:16:46 +00:00
# Type: boolean
2023-11-16 15:14:50 +00:00
# Default: "false"
2023-11-15 05:46:02 +00:00
fetch_additional_submodule_history: ''
2023-11-15 19:50:40 +00:00
# Depth of additional branch history fetched. NOTE: This can
2023-11-15 05:46:02 +00:00
# be adjusted to resolve errors with insufficient history.
2023-11-20 02:16:46 +00:00
# Type: string
2023-11-16 15:14:50 +00:00
# Default: "50"
2023-11-15 05:46:02 +00:00
fetch_depth: ''
2023-11-16 15:14:50 +00:00
# File and directory patterns used to detect changes (Defaults to the entire repo if unset).
2023-11-15 15:49:57 +00:00
# NOTE: Multiline file/directory patterns should not include quotes.
2023-11-20 02:16:46 +00:00
# Type: string
2023-11-15 05:46:02 +00:00
files: ''
# Source file(s) used to populate the `files` input.
2023-11-20 02:16:46 +00:00
# Type: string
2023-11-15 05:46:02 +00:00
files_from_source_file: ''
2023-11-20 03:15:32 +00:00
# Separator used to split the `files_from_source_file` input.
2023-11-20 02:16:46 +00:00
# Type: string
2023-11-16 15:14:50 +00:00
# Default: "\n"
2023-11-15 05:46:02 +00:00
files_from_source_file_separator: ''
2023-11-16 15:14:50 +00:00
# Ignore changes to these file(s). NOTE: Multiline file/directory patterns
2023-11-15 05:46:02 +00:00
# should not include quotes.
2023-11-20 02:16:46 +00:00
# Type: string
2023-11-15 05:46:02 +00:00
files_ignore: ''
# Source file(s) used to populate the `files_ignore` input
2023-11-20 02:16:46 +00:00
# Type: string
2023-11-15 05:46:02 +00:00
files_ignore_from_source_file: ''
# Separator used to split the `files_ignore_from_source_file` input
2023-11-20 02:16:46 +00:00
# Type: string
2023-11-16 15:14:50 +00:00
# Default: "\n"
2023-11-15 05:46:02 +00:00
files_ignore_from_source_file_separator: ''
# Separator used to split the `files_ignore` input
2023-11-20 02:16:46 +00:00
# Type: string
2023-11-16 15:14:50 +00:00
# Default: "\n"
2023-11-15 05:46:02 +00:00
files_ignore_separator: ''
# YAML used to define a set of file patterns
# to ignore changes
2023-11-20 02:16:46 +00:00
# Type: string
2023-11-15 05:46:02 +00:00
files_ignore_yaml: ''
2023-11-15 15:49:57 +00:00
# Source file(s) used to populate the `files_ignore_yaml` input. Example:
# https://github.com/tj-actions/changed-files/blob/main/test/changed-files.yml
2023-11-20 02:16:46 +00:00
# Type: string
2023-11-15 05:46:02 +00:00
files_ignore_yaml_from_source_file: ''
# Separator used to split the `files_ignore_yaml_from_source_file` input
2023-11-20 02:16:46 +00:00
# Type: string
2023-11-16 15:14:50 +00:00
# Default: "\n"
2023-11-15 05:46:02 +00:00
files_ignore_yaml_from_source_file_separator: ''
# Separator used to split the `files` input
2023-11-20 02:16:46 +00:00
# Type: string
2023-11-16 15:14:50 +00:00
# Default: "\n"
2023-11-15 05:46:02 +00:00
files_separator: ''
# YAML used to define a set of file patterns
# to detect changes
2023-11-20 02:16:46 +00:00
# Type: string
2023-11-15 05:46:02 +00:00
files_yaml: ''
2023-11-15 15:49:57 +00:00
# Source file(s) used to populate the `files_yaml` input. Example:
# https://github.com/tj-actions/changed-files/blob/main/test/changed-files.yml
2023-11-20 02:16:46 +00:00
# Type: string
2023-11-15 05:46:02 +00:00
files_yaml_from_source_file: ''
# Separator used to split the `files_yaml_from_source_file` input
2023-11-20 02:16:46 +00:00
# Type: string
2023-11-16 15:14:50 +00:00
# Default: "\n"
2023-11-15 05:46:02 +00:00
files_yaml_from_source_file_separator: ''
# Include `all_old_new_renamed_files` output. Note this can generate a large
2023-11-15 15:49:57 +00:00
# output See: #501 .
2023-11-20 02:16:46 +00:00
# Type: boolean
2023-11-16 15:14:50 +00:00
# Default: "false"
2023-11-15 05:46:02 +00:00
include_all_old_new_renamed_files: ''
# Output list of changed files in a JSON formatted
2023-11-15 15:49:57 +00:00
# string which can be used for matrix jobs. Example:
2024-02-07 03:18:39 +00:00
# https://github.com/tj-actions/changed-files/blob/main/.github/workflows/matrix-example.yml
2023-11-20 02:16:46 +00:00
# Type: boolean
2023-11-16 15:14:50 +00:00
# Default: "false"
2023-11-15 05:46:02 +00:00
json: ''
2024-03-09 01:29:44 +00:00
# Output changed files in a format that can be
# used for matrix jobs. Alias for setting inputs `json`
# to `true` and `escape_json` to `false` .
# Type: boolean
# Default: "false"
matrix: ''
2023-11-15 19:50:40 +00:00
# Apply the negation patterns first. NOTE: This affects how
2023-11-15 05:46:02 +00:00
# changed files are matched.
2023-11-20 02:16:46 +00:00
# Type: boolean
2023-11-16 15:14:50 +00:00
# Default: "false"
2023-11-15 05:46:02 +00:00
negation_patterns_first: ''
# Split character for old and new renamed filename pairs.
2023-11-20 02:16:46 +00:00
# Type: string
2023-11-16 15:14:50 +00:00
# Default: " "
2023-11-15 05:46:02 +00:00
old_new_files_separator: ''
# Split character for old and new filename pairs.
2023-11-20 02:16:46 +00:00
# Type: string
2023-11-16 15:14:50 +00:00
# Default: ","
2023-11-15 05:46:02 +00:00
old_new_separator: ''
# Directory to store output files.
2023-11-20 02:16:46 +00:00
# Type: string
2023-11-16 15:14:50 +00:00
# Default: ".github/outputs"
2023-11-15 05:46:02 +00:00
output_dir: ''
# Output renamed files as deleted and added files.
2023-11-20 02:16:46 +00:00
# Type: boolean
2023-11-16 15:14:50 +00:00
# Default: "false"
2023-11-15 05:46:02 +00:00
output_renamed_files_as_deleted_and_added: ''
# Specify a relative path under `$GITHUB_WORKSPACE` to locate the
# repository.
2023-11-20 02:16:46 +00:00
# Type: string
2023-11-16 15:14:50 +00:00
# Default: "."
2023-11-15 05:46:02 +00:00
path: ''
2023-11-15 19:50:40 +00:00
# Use non-ASCII characters to match files and output the
# filenames completely verbatim by setting this to `false`
2023-11-20 02:16:46 +00:00
# Type: boolean
2023-11-16 15:14:50 +00:00
# Default: "true"
2023-11-15 05:46:02 +00:00
quotepath: ''
# Recover deleted files.
2023-11-20 02:16:46 +00:00
# Type: boolean
2023-11-16 15:14:50 +00:00
# Default: "false"
2023-11-15 05:46:02 +00:00
recover_deleted_files: ''
# Recover deleted files to a new destination directory, defaults
# to the original location.
2023-11-20 02:16:46 +00:00
# Type: string
2023-11-15 05:46:02 +00:00
recover_deleted_files_to_destination: ''
# File and directory patterns used to recover deleted files,
# defaults to the patterns provided via the `files` , `files_from_source_file` ,
# `files_ignore` and `files_ignore_from_source_file` inputs or all deleted files if
# no patterns are provided.
2023-11-20 02:16:46 +00:00
# Type: string
2023-11-15 05:46:02 +00:00
recover_files: ''
# File and directory patterns to ignore when recovering deleted
# files.
2023-11-20 02:16:46 +00:00
# Type: string
2023-11-15 05:46:02 +00:00
recover_files_ignore: ''
# Separator used to split the `recover_files_ignore` input
2023-11-20 02:16:46 +00:00
# Type: string
2023-11-16 15:14:50 +00:00
# Default: "\n"
2023-11-15 05:46:02 +00:00
recover_files_ignore_separator: ''
# Separator used to split the `recover_files` input
2023-11-20 02:16:46 +00:00
# Type: string
2023-11-16 15:14:50 +00:00
# Default: "\n"
2023-11-15 05:46:02 +00:00
recover_files_separator: ''
2023-12-23 10:56:31 +00:00
# Apply sanitization to output filenames before being set as
# output.
# Type: boolean
# Default: "true"
safe_output: ''
2023-11-20 03:15:32 +00:00
# Split character for output strings.
2023-11-20 02:16:46 +00:00
# Type: string
2023-11-16 15:14:50 +00:00
# Default: " "
2023-11-15 05:46:02 +00:00
separator: ''
# Specify a different commit SHA or branch used for
# comparing changes
2023-11-20 02:16:46 +00:00
# Type: string
2023-11-15 05:46:02 +00:00
sha: ''
# Get changed files for commits whose timestamp is older
# than the given time.
2023-11-20 02:16:46 +00:00
# Type: string
2023-11-15 05:46:02 +00:00
since: ''
# Use the last commit on the remote branch as
# the `base_sha` . Defaults to the last non-merge commit on
# the target branch for pull request events and the
# previous remote commit of the current branch for push
# events.
2023-11-20 02:16:46 +00:00
# Type: boolean
2023-11-16 15:14:50 +00:00
# Default: "false"
2023-11-15 05:46:02 +00:00
since_last_remote_commit: ''
2024-02-18 05:12:36 +00:00
# Skip initially fetching additional history to improve performance for
# shallow repositories. NOTE: This could lead to errors with
# missing history. It's intended to be used when you've
# fetched all necessary history to perform the diff.
2023-11-20 02:16:46 +00:00
# Type: boolean
2023-11-16 15:14:50 +00:00
# Default: "false"
2023-11-15 05:46:02 +00:00
skip_initial_fetch: ''
2023-11-15 15:49:57 +00:00
# GitHub token used to fetch changed files from Github's
2023-11-15 05:46:02 +00:00
# API.
2023-11-20 02:16:46 +00:00
# Type: string
2023-11-16 15:14:50 +00:00
# Default: "${{ github.token }}"
2023-11-15 05:46:02 +00:00
token: ''
# Get changed files for commits whose timestamp is earlier
# than the given time.
2023-11-20 02:16:46 +00:00
# Type: string
2023-11-15 05:46:02 +00:00
until: ''
2024-01-13 08:58:40 +00:00
# Force the use of Github's REST API even when
# a local copy of the repository exists
# Type: boolean
# Default: "false"
use_rest_api: ''
2023-11-15 05:46:02 +00:00
# Write outputs to the `output_dir` defaults to `.github/outputs` folder.
2023-11-15 19:50:40 +00:00
# NOTE: This creates a `.txt` file by default and
2023-11-15 05:46:02 +00:00
# a `.json` file if `json` is set to `true` .
2023-11-20 02:16:46 +00:00
# Type: boolean
2023-11-16 15:14:50 +00:00
# Default: "false"
2023-11-15 05:46:02 +00:00
write_output_files: ''
```
2022-10-29 21:48:36 +00:00
<!-- AUTO - DOC - INPUT:END -->
2022-10-12 19:36:43 +00:00
2023-11-27 17:39:44 +00:00
## Useful Acronyms 🧮
| Acronym | Meaning |
|:---------:|:------------:|
| A | Added |
| C | Copied |
| M | Modified |
| D | Deleted |
| R | Renamed |
| T | Type changed |
| U | Unmerged |
| X | Unknown |
2023-12-07 03:37:03 +00:00
> \[!IMPORTANT]
>
2023-12-07 04:14:34 +00:00
> * When using `files_yaml*` inputs:
2023-12-14 21:57:20 +00:00
> * it's required to prefix all outputs with the key to ensure that the correct outputs are accessible.
2023-12-07 03:37:03 +00:00
>
2023-12-07 04:14:34 +00:00
> For example, if you use `test` as the key, you can access outputs like `added_files`, `any_changed`, and so on by prefixing them with the key `test_added_files` or `test_any_changed` etc.
2023-12-07 03:37:03 +00:00
2023-12-03 21:15:28 +00:00
## Outputs 📤
2023-12-03 21:14:48 +00:00
<!-- AUTO - DOC - OUTPUT:START - Do not remove or modify this section -->
| OUTPUT | TYPE | DESCRIPTION |
|------------------------------------------------------------------------------------------------------------------------------------------------|--------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| < a name = "output_added_files" ></ a > [added\_files](#output_added_files) | string | Returns only files that are < br > Added (A). |
| < a name = "output_added_files_count" ></ a > [added\_files\_count](#output_added_files_count) | string | Returns the number of `added_files` |
| < a name = "output_all_changed_and_modified_files" ></ a > [all\_changed\_and\_modified\_files](#output_all_changed_and_modified_files) | string | Returns all changed and modified < br > files i.e. *a combination of (ACMRDTUX)* |
| < a name = "output_all_changed_and_modified_files_count" ></ a > [all\_changed\_and\_modified\_files\_count](#output_all_changed_and_modified_files_count) | string | Returns the number of `all_changed_and_modified_files` |
| < a name = "output_all_changed_files" ></ a > [all\_changed\_files](#output_all_changed_files) | string | Returns all changed files i.e. < br > *a combination of all added, copied, modified and renamed files (ACMR)* |
| < a name = "output_all_changed_files_count" ></ a > [all\_changed\_files\_count](#output_all_changed_files_count) | string | Returns the number of `all_changed_files` |
| < a name = "output_all_modified_files" ></ a > [all\_modified\_files](#output_all_modified_files) | string | Returns all changed files i.e. < br > *a combination of all added, copied, modified, renamed and deleted files (ACMRD)*. |
| < a name = "output_all_modified_files_count" ></ a > [all\_modified\_files\_count](#output_all_modified_files_count) | string | Returns the number of `all_modified_files` |
| < a name = "output_all_old_new_renamed_files" ></ a > [all\_old\_new\_renamed\_files](#output_all_old_new_renamed_files) | string | Returns only files that are < br > Renamed and lists their old < br > and new names. **NOTE:** This < br > requires setting `include_all_old_new_renamed_files` to `true` . < br > Also, keep in mind that < br > this output is global and < br > wouldn't be nested in outputs < br > generated when the `*_yaml_*` input < br > is used. (R) |
| < a name = "output_all_old_new_renamed_files_count" ></ a > [all\_old\_new\_renamed\_files\_count](#output_all_old_new_renamed_files_count) | string | Returns the number of `all_old_new_renamed_files` |
2024-03-13 22:28:45 +00:00
| < a name = "output_any_changed" ></ a > [any\_changed](#output_any_changed) | string | Returns `true` when any of < br > the filenames provided using the < br > `files*` or `files_ignore*` inputs have changed. This < br > defaults to `true` when no < br > patterns are specified. i.e. *includes a combination of all added, copied, modified and renamed files (ACMR)* . |
| < a name = "output_any_deleted" ></ a > [any\_deleted](#output_any_deleted) | string | Returns `true` when any of < br > the filenames provided using the < br > `files*` or `files_ignore*` inputs have been deleted. < br > This defaults to `true` when < br > no patterns are specified. (D) |
| < a name = "output_any_modified" ></ a > [any\_modified](#output_any_modified) | string | Returns `true` when any of < br > the filenames provided using the < br > `files*` or `files_ignore*` inputs have been modified. < br > This defaults to `true` when < br > no patterns are specified. i.e. < br > *includes a combination of all added, copied, modified, renamed, and deleted files (ACMRD)*. |
2023-12-03 21:14:48 +00:00
| < a name = "output_changed_keys" ></ a > [changed\_keys](#output_changed_keys) | string | Returns all changed YAML keys < br > when the `files_yaml` input is < br > used. i.e. *key that contains any path that has either been added, copied, modified, and renamed (ACMR)* |
| < a name = "output_copied_files" ></ a > [copied\_files](#output_copied_files) | string | Returns only files that are < br > Copied (C). |
| < a name = "output_copied_files_count" ></ a > [copied\_files\_count](#output_copied_files_count) | string | Returns the number of `copied_files` |
| < a name = "output_deleted_files" ></ a > [deleted\_files](#output_deleted_files) | string | Returns only files that are < br > Deleted (D). |
| < a name = "output_deleted_files_count" ></ a > [deleted\_files\_count](#output_deleted_files_count) | string | Returns the number of `deleted_files` |
| < a name = "output_modified_files" ></ a > [modified\_files](#output_modified_files) | string | Returns only files that are < br > Modified (M). |
| < a name = "output_modified_files_count" ></ a > [modified\_files\_count](#output_modified_files_count) | string | Returns the number of `modified_files` |
| < a name = "output_modified_keys" ></ a > [modified\_keys](#output_modified_keys) | string | Returns all modified YAML keys < br > when the `files_yaml` input is < br > used. i.e. *key that contains any path that has either been added, copied, modified, and deleted (ACMRD)* |
2024-02-05 19:51:58 +00:00
| < a name = "output_only_changed" ></ a > [only\_changed](#output_only_changed) | string | Returns `true` when only files < br > provided using the `files*` or `files_ignore*` inputs < br > have changed. i.e. *includes a combination of all added, copied, modified and renamed files (ACMR)* . |
2024-03-13 22:28:45 +00:00
| < a name = "output_only_deleted" ></ a > [only\_deleted](#output_only_deleted) | string | Returns `true` when only files < br > provided using the `files*` or `files_ignore*` inputs < br > have been deleted. (D) |
| < a name = "output_only_modified" ></ a > [only\_modified](#output_only_modified) | string | Returns `true` when only files < br > provided using the `files*` or `files_ignore*` inputs < br > have been modified. (ACMRD). |
2023-12-03 21:14:48 +00:00
| < a name = "output_other_changed_files" ></ a > [other\_changed\_files](#output_other_changed_files) | string | Returns all other changed files < br > not listed in the files < br > input i.e. *includes a combination of all added, copied, modified and renamed files (ACMR)* . |
| < a name = "output_other_changed_files_count" ></ a > [other\_changed\_files\_count](#output_other_changed_files_count) | string | Returns the number of `other_changed_files` |
| < a name = "output_other_deleted_files" ></ a > [other\_deleted\_files](#output_other_deleted_files) | string | Returns all other deleted files < br > not listed in the files < br > input i.e. *a combination of all deleted files (D)* |
| < a name = "output_other_deleted_files_count" ></ a > [other\_deleted\_files\_count](#output_other_deleted_files_count) | string | Returns the number of `other_deleted_files` |
| < a name = "output_other_modified_files" ></ a > [other\_modified\_files](#output_other_modified_files) | string | Returns all other modified files < br > not listed in the files < br > input i.e. *a combination of all added, copied, modified, and deleted files (ACMRD)* |
| < a name = "output_other_modified_files_count" ></ a > [other\_modified\_files\_count](#output_other_modified_files_count) | string | Returns the number of `other_modified_files` |
| < a name = "output_renamed_files" ></ a > [renamed\_files](#output_renamed_files) | string | Returns only files that are < br > Renamed (R). |
| < a name = "output_renamed_files_count" ></ a > [renamed\_files\_count](#output_renamed_files_count) | string | Returns the number of `renamed_files` |
| < a name = "output_type_changed_files" ></ a > [type\_changed\_files](#output_type_changed_files) | string | Returns only files that have < br > their file type changed (T). |
| < a name = "output_type_changed_files_count" ></ a > [type\_changed\_files\_count](#output_type_changed_files_count) | string | Returns the number of `type_changed_files` |
| < a name = "output_unknown_files" ></ a > [unknown\_files](#output_unknown_files) | string | Returns only files that are < br > Unknown (X). |
| < a name = "output_unknown_files_count" ></ a > [unknown\_files\_count](#output_unknown_files_count) | string | Returns the number of `unknown_files` |
| < a name = "output_unmerged_files" ></ a > [unmerged\_files](#output_unmerged_files) | string | Returns only files that are < br > Unmerged (U). |
| < a name = "output_unmerged_files_count" ></ a > [unmerged\_files\_count](#output_unmerged_files_count) | string | Returns the number of `unmerged_files` |
2023-12-03 19:46:59 +00:00
2023-12-03 21:14:48 +00:00
<!-- AUTO - DOC - OUTPUT:END -->
2023-11-27 17:39:44 +00:00
2023-08-30 17:23:44 +00:00
## Versioning 🏷️
2023-03-14 17:01:05 +00:00
This GitHub Action follows the principles of [Semantic Versioning ](https://semver.org ) for versioning releases.
The format of the version string is as follows:
2023-06-15 17:01:34 +00:00
* major: indicates significant changes or new features that may not be backward compatible.
2023-03-25 13:03:30 +00:00
2023-06-15 17:01:34 +00:00
* minor: indicates minor changes or new features that are backward compatible.
2023-03-25 13:03:30 +00:00
2023-06-15 17:01:34 +00:00
* patch: indicates bug fixes or other small changes that are backward compatible.
2023-03-14 17:01:05 +00:00
2023-08-30 17:23:44 +00:00
## Examples 📄
2021-04-04 13:11:55 +00:00
2022-10-18 23:52:27 +00:00
< details >
< summary > Get all changed files in the current branch< / summary >
2021-03-14 19:42:54 +00:00
```yaml
...
2022-10-18 23:52:27 +00:00
- name: Get changed files
id: changed-files
2024-03-13 23:06:28 +00:00
uses: tj-actions/changed-files@v43
2022-10-18 23:52:27 +00:00
...
```
2022-10-19 00:08:53 +00:00
2022-10-18 23:52:27 +00:00
< / details >
2021-05-07 21:46:34 +00:00
2023-12-23 11:59:15 +00:00
< details >
< summary > Get all changed files without escaping unsafe filename characters< / summary >
```yaml
...
- name: Get changed files
id: changed-files
2024-03-13 23:06:28 +00:00
uses: tj-actions/changed-files@v43
2023-12-23 11:59:15 +00:00
with:
safe_output: false # set to false because we are using an environment variable to store the output and avoid command injection.
- name: List all added files
env:
ADDED_FILES: ${{ steps.changed-files.outputs.added_files }}
run: |
2024-02-02 13:21:28 +00:00
for file in ${ADDED_FILES}; do
2023-12-23 11:59:15 +00:00
echo "$file was added"
done
...
```
< / details >
2022-10-18 23:52:27 +00:00
< details >
2023-07-13 00:03:18 +00:00
< summary > Get all changed files and use a comma separator< / summary >
2021-08-28 01:53:03 +00:00
2022-10-18 23:52:27 +00:00
```yaml
...
- name: Get all changed files and use a comma separator in the output
id: changed-files
2024-03-13 23:06:28 +00:00
uses: tj-actions/changed-files@v43
2022-10-18 23:52:27 +00:00
with:
separator: ","
...
```
2021-05-01 16:17:17 +00:00
2022-10-18 23:52:27 +00:00
See [inputs ](#inputs ) for more information.
2022-10-19 00:08:53 +00:00
2022-10-18 23:52:27 +00:00
< / details >
2021-05-01 16:17:17 +00:00
2022-10-18 23:52:27 +00:00
< details >
< summary > Get all changed files and list all added files< / summary >
2021-04-02 12:08:05 +00:00
2022-10-18 23:52:27 +00:00
```yaml
...
- name: Get changed files
id: changed-files
2024-03-13 23:06:28 +00:00
uses: tj-actions/changed-files@v43
2022-12-30 05:27:08 +00:00
2022-10-18 23:52:27 +00:00
- name: List all added files
2023-12-22 21:07:32 +00:00
env:
2023-12-23 11:59:15 +00:00
ADDED_FILES: ${{ steps.changed-files.outputs.added_files }}
2022-10-18 23:52:27 +00:00
run: |
2024-02-02 13:21:28 +00:00
for file in ${ADDED_FILES}; do
2022-10-18 23:52:27 +00:00
echo "$file was added"
done
...
```
2021-05-01 16:17:17 +00:00
2022-10-18 23:52:27 +00:00
See [outputs ](#outputs ) for a list of all available outputs.
2022-10-19 00:08:53 +00:00
2022-10-18 23:52:27 +00:00
< / details >
2021-08-28 01:53:03 +00:00
2022-10-18 23:52:27 +00:00
< details >
< summary > Get all changed files and optionally run a step if a file was modified< / summary >
2021-08-28 01:53:03 +00:00
2022-10-18 23:52:27 +00:00
```yaml
...
- name: Get changed files
id: changed-files
2024-03-13 23:06:28 +00:00
uses: tj-actions/changed-files@v43
2022-10-31 04:15:32 +00:00
2022-10-18 23:52:27 +00:00
- name: Run a step if my-file.txt was modified
if: contains(steps.changed-files.outputs.modified_files, 'my-file.txt')
run: |
echo "my-file.txt file has been modified."
...
```
2021-09-05 12:22:47 +00:00
2022-10-18 23:52:27 +00:00
See [outputs ](#outputs ) for a list of all available outputs.
2022-10-19 00:08:53 +00:00
2022-10-18 23:52:27 +00:00
< / details >
2021-09-05 12:22:47 +00:00
2023-03-13 18:06:26 +00:00
< details >
2023-03-27 20:58:40 +00:00
< summary > Get all changed files and write the outputs to a txt file< / summary >
2023-03-13 18:06:26 +00:00
```yaml
...
2023-07-13 00:03:18 +00:00
- name: Get changed files and write the outputs to a Txt file
2023-03-27 20:58:40 +00:00
id: changed-files-write-output-files-txt
2024-03-13 23:06:28 +00:00
uses: tj-actions/changed-files@v43
2023-03-13 18:06:26 +00:00
with:
write_output_files: true
2023-05-25 18:22:24 +00:00
- name: Verify the contents of the .github/outputs/added_files.txt file
run: |
cat .github/outputs/added_files.txt
2023-03-13 18:06:26 +00:00
...
```
< / details >
< details >
2023-03-27 20:58:40 +00:00
< summary > Get all changed files and write the outputs to a json file< / summary >
2023-03-13 18:06:26 +00:00
```yaml
...
2023-07-13 00:03:18 +00:00
- name: Get changed files and write the outputs to a JSON file
2023-03-27 20:58:40 +00:00
id: changed-files-write-output-files-json
2024-03-13 23:06:28 +00:00
uses: tj-actions/changed-files@v43
2023-03-13 18:06:26 +00:00
with:
2023-03-27 20:58:40 +00:00
json: true
2023-03-13 18:06:26 +00:00
write_output_files: true
2023-05-25 18:22:24 +00:00
- name: Verify the contents of the .github/outputs/added_files.json file
run: |
cat .github/outputs/added_files.json
2023-03-13 18:06:26 +00:00
...
```
< / details >
2022-10-18 23:52:27 +00:00
< details >
< summary > Get all changed files using a list of files< / summary >
2021-08-28 01:53:03 +00:00
2022-10-18 23:52:27 +00:00
```yaml
...
- name: Get changed files
id: changed-files
2024-03-13 23:06:28 +00:00
uses: tj-actions/changed-files@v43
2022-10-18 23:52:27 +00:00
with:
files: |
my-file.txt
*.sh
*.png
!*.md
2023-10-26 03:35:54 +00:00
test_directory/**
2023-08-03 22:11:38 +00:00
** /*.sql
2022-10-18 23:52:27 +00:00
...
```
2022-10-19 00:08:53 +00:00
2022-10-18 23:52:27 +00:00
See [inputs ](#inputs ) for more information.
2021-09-06 15:09:47 +00:00
2022-10-18 23:52:27 +00:00
< / details >
2021-10-30 20:04:52 +00:00
2022-10-18 23:52:27 +00:00
< details >
2023-01-06 17:58:28 +00:00
< summary > Get all changed files using a list of files and take action based on the changes< / summary >
2022-10-18 23:52:27 +00:00
```yaml
...
- name: Get changed files
2023-01-05 19:24:02 +00:00
id: changed-files-specific
2024-03-13 23:06:28 +00:00
uses: tj-actions/changed-files@v43
2022-10-18 23:52:27 +00:00
with:
files: |
my-file.txt
*.sh
*.png
!*.md
2023-10-26 03:35:54 +00:00
test_directory/**
2023-08-03 22:11:38 +00:00
** /*.sql
2022-10-18 23:52:27 +00:00
- name: Run step if any of the listed files above change
if: steps.changed-files-specific.outputs.any_changed == 'true'
run: |
echo "One or more files listed above has changed."
- name: Run step if only the files listed above change
if: steps.changed-files-specific.outputs.only_changed == 'true'
run: |
echo "Only files listed above have changed."
- name: Run step if any of the listed files above is deleted
2023-01-05 19:24:02 +00:00
if: steps.changed-files-specific.outputs.any_deleted == 'true'
2023-12-22 21:07:32 +00:00
env:
2023-12-23 11:59:15 +00:00
DELETED_FILES: ${{ steps.changed-files-specific.outputs.deleted_files }}
2022-10-18 23:52:27 +00:00
run: |
2024-02-02 13:21:28 +00:00
for file in ${DELETED_FILES}; do
2022-10-18 23:52:27 +00:00
echo "$file was deleted"
done
- name: Run step if all listed files above have been deleted
2023-01-05 19:24:02 +00:00
if: steps.changed-files-specific.outputs.only_deleted == 'true'
2023-12-22 21:07:32 +00:00
env:
2023-12-23 11:59:15 +00:00
DELETED_FILES: ${{ steps.changed-files-specific.outputs.deleted_files }}
2022-10-18 23:52:27 +00:00
run: |
2024-02-02 13:21:28 +00:00
for file in ${DELETED_FILES}; do
2022-10-18 23:52:27 +00:00
echo "$file was deleted"
done
...
```
2022-10-19 00:08:53 +00:00
2022-10-18 23:52:27 +00:00
See [outputs ](#outputs ) for a list of all available outputs.
< / details >
< details >
< summary > Get all changed files using a source file or list of file(s) to populate to files input< / summary >
```yaml
...
- name: Get changed files using a source file or list of file(s) to populate to files input.
id: changed-files-specific-source-file
2024-03-13 23:06:28 +00:00
uses: tj-actions/changed-files@v43
2022-10-18 23:52:27 +00:00
with:
2022-11-17 19:33:38 +00:00
files_from_source_file: test/changed-files-list.txt
2022-10-18 23:52:27 +00:00
...
```
See [inputs ](#inputs ) for more information.
< / details >
2022-10-12 18:51:58 +00:00
2022-10-18 23:52:27 +00:00
< details >
< summary > Get changed files using a source file or list of file(s) to populate to files input and optionally specify more files< / summary >
```yaml
...
- name: Get changed files using a source file or list of file(s) to populate to files input and optionally specify more files.
id: changed-files-specific-source-file-and-specify-files
2024-03-13 23:06:28 +00:00
uses: tj-actions/changed-files@v43
2022-10-18 23:52:27 +00:00
with:
files_from_source_file: |
test/changed-files-list.txt
files: |
test.txt
...
```
2022-10-12 18:51:58 +00:00
2022-10-18 23:52:27 +00:00
See [inputs ](#inputs ) for more information.
< / details >
< details >
< summary > Get all changed files using a different SHA< / summary >
```yaml
...
- name: Get changed files using a different SHA
id: changed-files
2024-03-13 23:06:28 +00:00
uses: tj-actions/changed-files@v43
2022-10-18 23:52:27 +00:00
with:
sha: ${{ github.event.pull_request.head.sha }}
...
```
See [inputs ](#inputs ) for more information.
< / details >
< details >
< summary > Get all changed files using a different base SHA< / summary >
```yaml
...
- name: Get changed files using a different base SHA
id: changed-files
2024-03-13 23:06:28 +00:00
uses: tj-actions/changed-files@v43
2022-10-18 23:52:27 +00:00
with:
base_sha: ${{ github.event.pull_request.base.sha }}
...
```
See [inputs ](#inputs ) for more information.
< / details >
2023-01-19 02:02:19 +00:00
< details >
< summary > Get all changed files between the previous tag and the current tag< / summary >
```yaml
...
on:
push:
tags:
- 'v*'
jobs:
release:
name: Release
runs-on: ubuntu-latest
steps:
- name: Checkout
2023-09-04 20:42:58 +00:00
uses: actions/checkout@v4
2023-01-19 02:02:19 +00:00
with:
fetch-depth: 0
- name: Get changed files
id: changed-files
2024-03-13 23:06:28 +00:00
uses: tj-actions/changed-files@v43
2023-01-19 02:02:19 +00:00
2024-02-07 05:33:30 +00:00
- name: List changed files
env:
ALL_CHANGED_FILES: ${{ steps.changed-files.outputs.all_changed_files }}
run: |
echo "List all the files that have changed: $ALL_CHANGED_FILES"
2023-01-19 02:02:19 +00:00
- name: Get changed files in the .github folder
id: changed-files-specific
2024-03-13 23:06:28 +00:00
uses: tj-actions/changed-files@v43
2023-01-19 02:02:19 +00:00
with:
files: .github/**
- name: Run step if any file(s) in the .github folder change
if: steps.changed-files-specific.outputs.any_changed == 'true'
2023-12-22 21:07:32 +00:00
env:
2023-12-23 11:59:15 +00:00
ALL_CHANGED_FILES: ${{ steps.changed-files-specific.outputs.all_changed_files }}
2023-01-19 02:02:19 +00:00
run: |
2023-09-09 02:43:21 +00:00
echo "One or more files in the .github folder has changed."
2023-12-22 21:07:32 +00:00
echo "List all the files that have changed: $ALL_CHANGED_FILES"
2023-01-19 02:02:19 +00:00
...
```
See [inputs ](#inputs ) for more information.
< / details >
2022-10-18 23:52:27 +00:00
< details >
< summary > Get all changed files for a repository located in a different path< / summary >
```yaml
...
- name: Checkout into dir1
2023-09-04 20:42:58 +00:00
uses: actions/checkout@v4
2022-10-18 23:52:27 +00:00
with:
fetch-depth: 0
path: dir1
- name: Run changed-files with defaults in dir1
id: changed-files-for-dir1
2024-03-13 23:06:28 +00:00
uses: tj-actions/changed-files@v43
2022-10-18 23:52:27 +00:00
with:
path: dir1
- name: List all added files in dir1
2023-12-22 21:07:32 +00:00
env:
ADDED_FILES: |-
${{ steps.changed-files-for-dir1.outputs.added_files }}
2022-10-18 23:52:27 +00:00
run: |
2024-02-02 13:21:28 +00:00
for file in ${ADDED_FILES}; do
2022-10-18 23:52:27 +00:00
echo "$file was added"
done
...
```
See [inputs ](#inputs ) for more information.
< / details >
< details >
2023-07-13 00:03:18 +00:00
< summary > Get all changed files with non-äšćįí characters i.e (Filename in other languages)< / summary >
2022-10-18 23:52:27 +00:00
```yaml
...
- name: Run changed-files with quotepath disabled
id: changed-files-quotepath
2024-03-13 23:06:28 +00:00
uses: tj-actions/changed-files@v43
2022-10-18 23:52:27 +00:00
with:
quotepath: "false"
- name: Run changed-files with quotepath disabled for a specified list of file(s)
id: changed-files-quotepath-specific
2024-03-13 23:06:28 +00:00
uses: tj-actions/changed-files@v43
2022-10-18 23:52:27 +00:00
with:
files: test/test-è.txt
quotepath: "false"
...
```
See [inputs ](#inputs ) for more information.
< / details >
< details >
< summary > Get all changed files using the last successful commit of the base branch< / summary >
< ul >
< li >
< details >
< summary > Push event< / summary >
```yaml
...
2022-05-31 02:46:18 +00:00
- name: Get branch name
id: branch-name
2022-09-25 03:20:05 +00:00
uses: tj-actions/branch-names@v6
2022-05-31 02:46:18 +00:00
2022-11-23 22:02:10 +00:00
- uses: nrwl/nx-set-shas@v3
2022-05-31 02:46:18 +00:00
id: last_successful_commit_push
with:
2022-12-30 05:27:08 +00:00
main-branch-name: ${{ steps.branch-name.outputs.current_branch }} # Get the last successful commit for the current branch.
2022-11-23 22:02:10 +00:00
workflow-id: 'test.yml'
2022-05-31 02:46:18 +00:00
- name: Run changed-files with the commit of the last successful test workflow run
id: changed-files-base-sha-push
2024-03-13 23:06:28 +00:00
uses: tj-actions/changed-files@v43
2022-05-31 02:46:18 +00:00
with:
2022-11-23 22:02:10 +00:00
base_sha: ${{ steps.last_successful_commit_push.outputs.base }}
2022-10-18 23:52:27 +00:00
...
```
2022-10-19 00:08:53 +00:00
2022-10-18 23:52:27 +00:00
< / details >
< / li >
< li >
< details >
< summary > Pull request events < / summary >
2022-05-31 02:46:18 +00:00
2022-10-18 23:52:27 +00:00
```yaml
...
2022-05-31 02:46:18 +00:00
- name: Get branch name
id: branch-name
uses: tj-actions/branch-names@v5
2022-11-23 22:02:10 +00:00
- uses: nrwl/nx-set-shas@v3
2022-05-31 02:46:18 +00:00
id: last_successful_commit_pull_request
with:
2023-07-13 00:03:18 +00:00
main-branch-name: ${{ steps.branch-name.outputs.base_ref_branch }} # Get the last successful commit on the master or main branch
2022-05-31 02:46:18 +00:00
workflow_id: 'test.yml'
2023-07-13 00:03:18 +00:00
- name: Run changed-files with the commit of the last successful test workflow run on the main branch
2022-05-31 02:46:18 +00:00
id: changed-files-base-sha-pull-request
2024-03-13 23:06:28 +00:00
uses: tj-actions/changed-files@v43
2022-05-31 02:46:18 +00:00
with:
2022-11-23 22:02:10 +00:00
base_sha: ${{ steps.last_successful_commit_pull_request.outputs.base }}
2022-10-18 23:52:27 +00:00
...
```
2021-10-30 20:04:52 +00:00
2022-10-18 23:52:27 +00:00
< / details >
< / li >
< / ul >
2022-10-13 17:10:10 +00:00
2023-08-19 01:52:10 +00:00
> **Warning**
2023-08-03 22:17:03 +00:00
>
2023-08-03 22:14:44 +00:00
> This setting overrides the commit sha used by setting `since_last_remote_commit` to true.
2022-10-18 23:52:27 +00:00
> It is recommended to use either solution that works for your use case.
2022-08-21 02:41:36 +00:00
2022-10-18 23:52:27 +00:00
See [inputs ](#inputs ) for more information.
2022-08-21 02:41:36 +00:00
2022-10-18 23:52:27 +00:00
< / details >
< details >
< summary > Get all changed files but only return the directory names< / summary >
```yaml
...
- name: Run changed-files with dir_names
id: changed-files-dir-names
2024-03-13 23:06:28 +00:00
uses: tj-actions/changed-files@v43
2022-10-18 23:52:27 +00:00
with:
dir_names: "true"
...
2021-03-14 19:42:54 +00:00
```
2022-10-18 23:52:27 +00:00
See [inputs ](#inputs ) for more information.
< / details >
< details >
< summary > Get all changed files and return JSON formatted outputs< / summary >
```yaml
...
2023-07-13 00:03:18 +00:00
- name: Run changed-files with JSON output
2022-10-18 23:52:27 +00:00
id: changed-files-json
2024-03-13 23:06:28 +00:00
uses: tj-actions/changed-files@v43
2022-10-18 23:52:27 +00:00
with:
json: "true"
...
```
See [inputs ](#inputs ) for more information.
< / details >
< details >
< summary > Get all changed files by commits pushed in the past< / summary >
```yaml
...
- name: Get changed-files since 2022-08-19
id: changed-files-since
2024-03-13 23:06:28 +00:00
uses: tj-actions/changed-files@v43
2022-10-18 23:52:27 +00:00
with:
since: "2022-08-19"
2022-10-31 04:15:32 +00:00
2022-10-18 23:52:27 +00:00
- name: Get changed-files until 2022-08-20
id: changed-files-until
2024-03-13 23:06:28 +00:00
uses: tj-actions/changed-files@v43
2022-10-18 23:52:27 +00:00
with:
until: "2022-08-20"
...
```
See [inputs ](#inputs ) for more information.
< / details >
2023-08-30 17:23:44 +00:00
## Real-world usage 🌐
2022-10-18 23:52:27 +00:00
2023-08-30 17:23:44 +00:00
### Open source projects 📦
2023-08-25 20:28:36 +00:00
2023-03-29 15:59:56 +00:00
* [vitejs/vite: uses tj-actions/changed-files to automate testing ](https://github.com/vitejs/vite/blob/8da04227d6f818a8ad9efc0056101968037c2e36/.github/workflows/ci.yml#L61 )
2023-03-28 22:23:54 +00:00
2023-03-29 15:59:56 +00:00
* [qgis/QGIS: uses tj-actions/changed-files to automate spell checking ](https://github.com/qgis/QGIS/blob/a5333497e90ac9de4ca70463d8e0b64c3f294d63/.github/workflows/code_layout.yml#L147 )
2023-03-28 22:23:54 +00:00
2023-03-29 15:59:56 +00:00
* [coder/code-server: uses tj-actions/changed-files to automate detecting changes and run steps based on the outcome ](https://github.com/coder/code-server/blob/c32a31d802f679846876b8ad9aacff6cf7b5361d/.github/workflows/build.yaml#L48 )
2024-02-13 16:20:59 +00:00
* [tldr-pages/tldr: uses tj-actions/changed-files to automate detecting spelling errors ](https://github.com/tldr-pages/tldr/blob/c1b714c55cb0048037b79a681a10d7f3ddb0164c/.github/workflows/codespell.yml#L18-L26 )
2023-03-29 15:59:56 +00:00
* [nodejs/docker-node: uses tj-actions/changed-files to generate matrix jobs based on changes detected ](https://github.com/nodejs/docker-node/blob/3c4fa6daf06a4786d202f2f610351837806a0380/.github/workflows/build-test.yml#L29 )
2023-03-28 22:23:54 +00:00
2023-05-29 02:26:25 +00:00
* [refined-github: uses tj-actions/changed-files to automate test URL validation in added/edited files ](https://github.com/refined-github/refined-github/blob/b754bfe58904da8a599d7876fdaaf18302785629/.github/workflows/features.yml#L35 )
* [aws-doc-sdk-examples: uses tj-actions/changed-files to automate testing ](https://github.com/awsdocs/aws-doc-sdk-examples/blob/2393723ef6b0cad9502f4852f5c72f7be58ca89d/.github/workflows/javascript.yml#L22 )
2024-02-13 16:20:59 +00:00
* [nhost: uses tj-actions/changed-files to automate testing based on changes detected ](https://github.com/nhost/nhost/blob/71a8ce444618a8ac4d660518172fba4883c4014b/.github/workflows/ci.yaml#L44-L48 )
2023-06-26 19:28:37 +00:00
2023-08-25 20:29:10 +00:00
* [qmk\_firmware uses tj-actions/changed-files to run linters ](https://github.com/qmk/qmk_firmware/blob/7a737235ffd49c32d2c5561e8fe53fd96baa7f96/.github/workflows/lint.yml#L30 )
2023-06-01 17:29:04 +00:00
2024-02-25 16:48:32 +00:00
* [argo-cd uses tj-actions/chnaged-files to detect changed frontend or backend files ](https://github.com/argoproj/argo-cd/blob/5bc1850aa1d26301043be9f2fb825d88c80c111c/.github/workflows/ci-build.yaml#L33 )
2024-01-21 04:42:48 +00:00
* [argo-workflows uses tj-actions/changed-files to run specific jobs based on changes detected ](https://github.com/argoproj/argo-workflows/blob/baef4856ff2603c76dbe277c825eaa3f9788fc91/.github/workflows/ci-build.yaml#L34 )
2023-03-29 16:00:54 +00:00
And many more...
2023-08-30 17:23:44 +00:00
### Scalability Example 📈
2023-08-25 20:28:36 +00:00
![image ](https://github.com/tj-actions/changed-files/assets/17484350/23767413-4c51-42fb-ab1c-39ef72c44904 )
2023-10-07 17:49:50 +00:00
## Important Notice ⚠️
2021-10-23 13:41:29 +00:00
2023-11-28 18:23:42 +00:00
> \[!IMPORTANT]
2023-05-25 18:26:26 +00:00
>
2022-02-12 22:08:47 +00:00
> * Spaces in file names can introduce bugs when using bash loops. See: [#216](https://github.com/tj-actions/changed-files/issues/216)
2023-07-18 08:56:15 +00:00
> However, this action will handle spaces in file names, with a recommendation of using a separator to prevent any hidden issues.
2023-03-14 17:01:05 +00:00
>
2021-10-23 16:03:11 +00:00
> ![Screen Shot 2021-10-23 at 9 37 34 AM](https://user-images.githubusercontent.com/17484350/138558767-b13c90bf-a1ae-4e86-9520-70a6a4624f41.png)
2021-10-23 13:41:29 +00:00
2023-08-30 17:23:44 +00:00
## Migration guide 🔄
2022-12-12 23:20:59 +00:00
With the switch from using grep's Extended regex to match files to the natively supported workflow glob pattern matching syntax introduced in [v13 ](https://github.com/tj-actions/changed-files/releases/tag/v13 ) you'll need to modify patterns used to match `files` .
2023-04-07 21:39:00 +00:00
```diff
2022-12-12 23:20:59 +00:00
...
- name: Get specific changed files
id: changed-files-specific
uses: tj-actions/changed-files@v24
with:
files: |
2023-04-07 21:39:00 +00:00
- \.sh$
- .(sql|py)$
- ^(dir1|dir2)
2023-08-03 22:11:38 +00:00
+ ** /*.{sh,sql,py}
+ {dir1,dir2}/**
2022-12-12 23:20:59 +00:00
```
2023-03-14 17:19:11 +00:00
* Free software: [MIT license ](LICENSE )
2023-08-30 17:23:44 +00:00
## Credits 👏
2021-03-05 02:36:52 +00:00
2023-04-14 02:35:51 +00:00
This package was created with [cookiecutter-action ](https://github.com/tj-actions/cookiecutter-action ).
2021-03-05 02:36:52 +00:00
2022-12-16 14:27:46 +00:00
* [tj-actions/auto-doc ](https://github.com/tj-actions/auto-doc )
2022-12-16 14:45:25 +00:00
* [tj-actions/verify-changed-files ](https://github.com/tj-actions/verify-changed-files )
2022-06-07 14:43:44 +00:00
* [tj-actions/demo ](https://github.com/tj-actions/demo )
2022-10-31 01:17:22 +00:00
* [tj-actions/demo2 ](https://github.com/tj-actions/demo2 )
2022-11-07 14:11:40 +00:00
* [tj-actions/demo3 ](https://github.com/tj-actions/demo3 )
2022-10-02 12:35:22 +00:00
* [tj-actions/release-tagger ](https://github.com/tj-actions/release-tagger )
2022-01-10 19:42:33 +00:00
2023-08-30 17:23:44 +00:00
## Report Bugs 🐛
2021-03-05 02:36:52 +00:00
Report bugs at https://github.com/tj-actions/changed-files/issues.
If you are reporting a bug, please include:
2021-06-09 15:55:30 +00:00
* Your operating system name and version.
2022-11-08 20:24:38 +00:00
* Any details about your workflow that might be helpful in troubleshooting. (**NOTE**: Ensure that you include full log outputs with debugging enabled)
2021-06-09 15:55:30 +00:00
* Detailed steps to reproduce the bug.
2021-06-09 23:07:22 +00:00
## Contributors ✨
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
<!-- ALL - CONTRIBUTORS - LIST:START - Do not remove or modify this section -->
2024-02-17 22:32:19 +00:00
2021-06-09 23:07:22 +00:00
<!-- prettier - ignore - start -->
2024-02-17 22:32:19 +00:00
2021-06-09 23:07:22 +00:00
<!-- markdownlint - disable -->
2024-02-17 22:32:19 +00:00
2021-06-09 23:07:22 +00:00
< table >
2022-10-05 16:14:01 +00:00
< tbody >
< tr >
2023-03-29 15:54:42 +00:00
< td align = "center" valign = "top" width = "14.28%" > < a href = "https://github.com/jsoref" > < img src = "https://avatars.githubusercontent.com/u/2119212?v=4?s=100" width = "100px;" alt = "Josh Soref" / > < br / > < sub > < b > Josh Soref< / b > < / sub > < / a > < br / > < a href = "https://github.com/tj-actions/changed-files/commits?author=jsoref" title = "Documentation" > 📖< / a > < / td >
< td align = "center" valign = "top" width = "14.28%" > < a href = "https://github.com/monoxgas" > < img src = "https://avatars.githubusercontent.com/u/1223016?v=4?s=100" width = "100px;" alt = "Nick Landers" / > < br / > < sub > < b > Nick Landers< / b > < / sub > < / a > < br / > < a href = "https://github.com/tj-actions/changed-files/commits?author=monoxgas" title = "Code" > 💻< / a > < / td >
< td align = "center" valign = "top" width = "14.28%" > < a href = "https://github.com/Kras4ooo" > < img src = "https://avatars.githubusercontent.com/u/1948054?v=4?s=100" width = "100px;" alt = "Krasimir Nikolov" / > < br / > < sub > < b > Krasimir Nikolov< / b > < / sub > < / a > < br / > < a href = "https://github.com/tj-actions/changed-files/commits?author=Kras4ooo" title = "Code" > 💻< / a > < a href = "https://github.com/tj-actions/changed-files/commits?author=Kras4ooo" title = "Documentation" > 📖< / a > < / td >
< td align = "center" valign = "top" width = "14.28%" > < a href = "https://github.com/IvanPizhenko" > < img src = "https://avatars.githubusercontent.com/u/11859904?v=4?s=100" width = "100px;" alt = "Ivan Pizhenko" / > < br / > < sub > < b > Ivan Pizhenko< / b > < / sub > < / a > < br / > < a href = "https://github.com/tj-actions/changed-files/commits?author=IvanPizhenko" title = "Code" > 💻< / a > < a href = "https://github.com/tj-actions/changed-files/commits?author=IvanPizhenko" title = "Documentation" > 📖< / a > < / td >
< td align = "center" valign = "top" width = "14.28%" > < a href = "https://github.com/talva-tr" > < img src = "https://avatars.githubusercontent.com/u/82046981?v=4?s=100" width = "100px;" alt = "talva-tr" / > < br / > < sub > < b > talva-tr< / b > < / sub > < / a > < br / > < a href = "https://github.com/tj-actions/changed-files/commits?author=talva-tr" title = "Code" > 💻< / a > < / td >
< td align = "center" valign = "top" width = "14.28%" > < a href = "https://bandism.net/" > < img src = "https://avatars.githubusercontent.com/u/22633385?v=4?s=100" width = "100px;" alt = "Ikko Ashimine" / > < br / > < sub > < b > Ikko Ashimine< / b > < / sub > < / a > < br / > < a href = "https://github.com/tj-actions/changed-files/commits?author=eltociear" title = "Documentation" > 📖< / a > < / td >
< td align = "center" valign = "top" width = "14.28%" > < a href = "https://github.com/Zamiell" > < img src = "https://avatars.githubusercontent.com/u/5511220?v=4?s=100" width = "100px;" alt = "James" / > < br / > < sub > < b > James< / b > < / sub > < / a > < br / > < a href = "https://github.com/tj-actions/changed-files/commits?author=Zamiell" title = "Documentation" > 📖< / a > < / td >
2022-10-05 16:14:01 +00:00
< / tr >
< tr >
2023-03-29 15:54:42 +00:00
< td align = "center" valign = "top" width = "14.28%" > < a href = "https://github.com/wushujames" > < img src = "https://avatars.githubusercontent.com/u/677529?v=4?s=100" width = "100px;" alt = "James Cheng" / > < br / > < sub > < b > James Cheng< / b > < / sub > < / a > < br / > < a href = "https://github.com/tj-actions/changed-files/commits?author=wushujames" title = "Documentation" > 📖< / a > < / td >
< td align = "center" valign = "top" width = "14.28%" > < a href = "https://qiita.com/SUZUKI_Masaya" > < img src = "https://avatars.githubusercontent.com/u/15100604?v=4?s=100" width = "100px;" alt = "Masaya Suzuki" / > < br / > < sub > < b > Masaya Suzuki< / b > < / sub > < / a > < br / > < a href = "https://github.com/tj-actions/changed-files/commits?author=massongit" title = "Code" > 💻< / a > < / td >
< td align = "center" valign = "top" width = "14.28%" > < a href = "https://fagai.net" > < img src = "https://avatars.githubusercontent.com/u/1772112?v=4?s=100" width = "100px;" alt = "fagai" / > < br / > < sub > < b > fagai< / b > < / sub > < / a > < br / > < a href = "https://github.com/tj-actions/changed-files/commits?author=fagai" title = "Documentation" > 📖< / a > < / td >
< td align = "center" valign = "top" width = "14.28%" > < a href = "https://github.com/pkit" > < img src = "https://avatars.githubusercontent.com/u/805654?v=4?s=100" width = "100px;" alt = "Constantine Peresypkin" / > < br / > < sub > < b > Constantine Peresypkin< / b > < / sub > < / a > < br / > < a href = "https://github.com/tj-actions/changed-files/commits?author=pkit" title = "Code" > 💻< / a > < / td >
< td align = "center" valign = "top" width = "14.28%" > < a href = "https://github.com/deronnax" > < img src = "https://avatars.githubusercontent.com/u/439279?v=4?s=100" width = "100px;" alt = "Mathieu Dupuy" / > < br / > < sub > < b > Mathieu Dupuy< / b > < / sub > < / a > < br / > < a href = "https://github.com/tj-actions/changed-files/commits?author=deronnax" title = "Documentation" > 📖< / a > < / td >
< td align = "center" valign = "top" width = "14.28%" > < a href = "https://github.com/JoeOvo" > < img src = "https://avatars.githubusercontent.com/u/100686542?v=4?s=100" width = "100px;" alt = "Joe Moggridge" / > < br / > < sub > < b > Joe Moggridge< / b > < / sub > < / a > < br / > < a href = "https://github.com/tj-actions/changed-files/commits?author=JoeOvo" title = "Documentation" > 📖< / a > < / td >
< td align = "center" valign = "top" width = "14.28%" > < a href = "https://www.credly.com/users/thyarles/badges" > < img src = "https://avatars.githubusercontent.com/u/1340046?v=4?s=100" width = "100px;" alt = "Charles Santos" / > < br / > < sub > < b > Charles Santos< / b > < / sub > < / a > < br / > < a href = "https://github.com/tj-actions/changed-files/commits?author=thyarles" title = "Code" > 💻< / a > < / td >
2022-10-05 16:14:01 +00:00
< / tr >
< tr >
2023-03-29 15:54:42 +00:00
< td align = "center" valign = "top" width = "14.28%" > < a href = "https://github.com/kostiantyn-korniienko-aurea" > < img src = "https://avatars.githubusercontent.com/u/37180625?v=4?s=100" width = "100px;" alt = "Kostiantyn Korniienko" / > < br / > < sub > < b > Kostiantyn Korniienko< / b > < / sub > < / a > < br / > < a href = "https://github.com/tj-actions/changed-files/commits?author=kostiantyn-korniienko-aurea" title = "Documentation" > 📖< / a > < / td >
< td align = "center" valign = "top" width = "14.28%" > < a href = "https://github.com/lpulley" > < img src = "https://avatars.githubusercontent.com/u/7193187?v=4?s=100" width = "100px;" alt = "Logan Pulley" / > < br / > < sub > < b > Logan Pulley< / b > < / sub > < / a > < br / > < a href = "https://github.com/tj-actions/changed-files/commits?author=lpulley" title = "Code" > 💻< / a > < / td >
< td align = "center" valign = "top" width = "14.28%" > < a href = "https://www.linkedin.com/in/kenji-miyake/" > < img src = "https://avatars.githubusercontent.com/u/31987104?v=4?s=100" width = "100px;" alt = "Kenji Miyake" / > < br / > < sub > < b > Kenji Miyake< / b > < / sub > < / a > < br / > < a href = "https://github.com/tj-actions/changed-files/commits?author=kenji-miyake" title = "Code" > 💻< / a > < / td >
< td align = "center" valign = "top" width = "14.28%" > < a href = "https://github.com/adonisgarciac" > < img src = "https://avatars.githubusercontent.com/u/71078987?v=4?s=100" width = "100px;" alt = "adonisgarciac" / > < br / > < sub > < b > adonisgarciac< / b > < / sub > < / a > < br / > < a href = "https://github.com/tj-actions/changed-files/commits?author=adonisgarciac" title = "Code" > 💻< / a > < a href = "https://github.com/tj-actions/changed-files/commits?author=adonisgarciac" title = "Documentation" > 📖< / a > < / td >
< td align = "center" valign = "top" width = "14.28%" > < a href = "https://github.com/cfernhout" > < img src = "https://avatars.githubusercontent.com/u/22294606?v=4?s=100" width = "100px;" alt = "Chiel Fernhout" / > < br / > < sub > < b > Chiel Fernhout< / b > < / sub > < / a > < br / > < a href = "https://github.com/tj-actions/changed-files/commits?author=cfernhout" title = "Documentation" > 📖< / a > < / td >
< td align = "center" valign = "top" width = "14.28%" > < a href = "https://github.com/albertoperdomo2" > < img src = "https://avatars.githubusercontent.com/u/62241095?v=4?s=100" width = "100px;" alt = "Alberto Perdomo" / > < br / > < sub > < b > Alberto Perdomo< / b > < / sub > < / a > < br / > < a href = "https://github.com/tj-actions/changed-files/commits?author=albertoperdomo2" title = "Documentation" > 📖< / a > < / td >
2023-09-19 16:39:08 +00:00
< td align = "center" valign = "top" width = "14.28%" > < a href = "https://arthurvolant.com" > < img src = "https://avatars.githubusercontent.com/u/37664438?v=4?s=100" width = "100px;" alt = "Arthur" / > < br / > < sub > < b > Arthur< / b > < / sub > < / a > < br / > < a href = "https://github.com/tj-actions/changed-files/issues?q=author%3AV0lantis" title = "Bug reports" > 🐛< / a > < a href = "https://github.com/tj-actions/changed-files/commits?author=V0lantis" title = "Code" > 💻< / a > < / td >
2022-10-05 16:14:01 +00:00
< / tr >
2023-12-10 06:55:41 +00:00
< tr >
< td align = "center" valign = "top" width = "14.28%" > < a href = "https://github.com/rodrigorfk" > < img src = "https://avatars.githubusercontent.com/u/1995033?v=4?s=100" width = "100px;" alt = "Rodrigo Fior Kuntzer" / > < br / > < sub > < b > Rodrigo Fior Kuntzer< / b > < / sub > < / a > < br / > < a href = "https://github.com/tj-actions/changed-files/commits?author=rodrigorfk" title = "Code" > 💻< / a > < a href = "https://github.com/tj-actions/changed-files/commits?author=rodrigorfk" title = "Tests" > ⚠️< / a > < a href = "https://github.com/tj-actions/changed-files/issues?q=author%3Arodrigorfk" title = "Bug reports" > 🐛< / a > < / td >
2024-01-28 22:53:00 +00:00
< td align = "center" valign = "top" width = "14.28%" > < a href = "https://github.com/levenleven" > < img src = "https://avatars.githubusercontent.com/u/6463364?v=4?s=100" width = "100px;" alt = "Aleksey Levenstein" / > < br / > < sub > < b > Aleksey Levenstein< / b > < / sub > < / a > < br / > < a href = "https://github.com/tj-actions/changed-files/commits?author=levenleven" title = "Documentation" > 📖< / a > < / td >
2024-02-02 13:20:26 +00:00
< td align = "center" valign = "top" width = "14.28%" > < a href = "https://github.com/dan-hill2802" > < img src = "https://avatars.githubusercontent.com/u/5046322?v=4?s=100" width = "100px;" alt = "Daniel Hill" / > < br / > < sub > < b > Daniel Hill< / b > < / sub > < / a > < br / > < a href = "https://github.com/tj-actions/changed-files/commits?author=dan-hill2802" title = "Documentation" > 📖< / a > < / td >
2024-02-06 23:48:51 +00:00
< td align = "center" valign = "top" width = "14.28%" > < a href = "https://keisukeyamashita.com" > < img src = "https://avatars.githubusercontent.com/u/23056537?v=4?s=100" width = "100px;" alt = "KeisukeYamashita" / > < br / > < sub > < b > KeisukeYamashita< / b > < / sub > < / a > < br / > < a href = "https://github.com/tj-actions/changed-files/commits?author=KeisukeYamashita" title = "Documentation" > 📖< / a > < / td >
2024-02-17 22:31:24 +00:00
< td align = "center" valign = "top" width = "14.28%" > < a href = "https://github.com/codesculpture" > < img src = "https://avatars.githubusercontent.com/u/63452117?v=4?s=100" width = "100px;" alt = "Aravind" / > < br / > < sub > < b > Aravind< / b > < / sub > < / a > < br / > < a href = "https://github.com/tj-actions/changed-files/commits?author=codesculpture" title = "Code" > 💻< / a > < a href = "https://github.com/tj-actions/changed-files/issues?q=author%3Acodesculpture" title = "Bug reports" > 🐛< / a > < / td >
2023-12-10 06:55:41 +00:00
< / tr >
2022-10-05 16:14:01 +00:00
< / tbody >
2021-06-09 23:07:22 +00:00
< / table >
<!-- markdownlint - restore -->
2024-02-17 22:32:19 +00:00
2021-06-09 23:07:22 +00:00
<!-- prettier - ignore - end -->
<!-- ALL - CONTRIBUTORS - LIST:END -->
2021-06-10 01:01:10 +00:00
This project follows the [all-contributors ](https://github.com/all-contributors/all-contributors ) specification. Contributions of any kind welcome!