Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/tj-actions/changed-files

:octocat: Github action to retrieve all (added, copied, modified, deleted, renamed, type changed, unmerged, unknown) files and directories.
https://github.com/tj-actions/changed-files

actions change-detection change-detetion changed-file changed-files ci ci-cd conditional-execution continuous-delivery continuous-integration github github-actions modified modified-files monorepo restore-files submodules workflows yaml-files

Last synced: 21 days ago
JSON representation

:octocat: Github action to retrieve all (added, copied, modified, deleted, renamed, type changed, unmerged, unknown) files and directories.

Host: GitHub
URL: https://github.com/tj-actions/changed-files
Owner: tj-actions
License: mit
Created: 2021-03-05T02:35:53.000Z (over 3 years ago)
Default Branch: main
Last Pushed: 2024-04-13T20:46:52.000Z (7 months ago)
Last Synced: 2024-04-14T01:46:19.466Z (7 months ago)
Topics: actions, change-detection, change-detetion, changed-file, changed-files, ci, ci-cd, conditional-execution, continuous-delivery, continuous-integration, github, github-actions, modified, modified-files, monorepo, restore-files, submodules, workflows, yaml-files
Language: TypeScript
Homepage:
Size: 31.1 MB
Stars: 1,498
Watchers: 7
Forks: 166
Open Issues: 1
Metadata Files:
- Readme: README.md
- Changelog: HISTORY.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md

Awesome Lists containing this project

awesome-ccamel - tj-actions/changed-files - :octocat: Github action to retrieve all (added, copied, modified, deleted, renamed, type changed, unmerged, unknown) files and directories. (TypeScript)
stars - tj-actions/changed-files - :octocat: Github action to retrieve all (added, copied, modified, deleted, renamed, type changed, unmerged, unknown) files and directories. (TypeScript)

README

[![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)
[![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)

[![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)
[![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)
[![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)

[![All Contributors](https://img.shields.io/badge/all_contributors-27-orange.svg?style=flat-square)](#contributors-)

## changed-files

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.

> \[!NOTE]
>
> * 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.
>
> See: https://github.com/tj-actions/verify-changed-files instead.

## Table of contents

* [Features 🚀](#features-)
* [Usage 💻](#usage-)
* [On `pull_request` 🔀](#on-pull_request-)
* [Using local .git directory 📁](#using-local-git-directory-)
* [Using Github's API :octocat:](#using-githubs-api-octocat)
* [On `push` ⬆️](#on-push-️)
* [Other supported events :electron:](#other-supported-events-electron)
* [Inputs ⚙️](#inputs-️)
* [Useful Acronyms 🧮](#useful-acronyms-)
* [Outputs 📤](#outputs-)
* [Versioning 🏷️](#versioning-️)
* [Examples 📄](#examples-)
* [Real-world usage 🌐](#real-world-usage-)
* [Open source projects 📦](#open-source-projects-)
* [Scalability Example 📈](#scalability-example-)
* [Important Notice ⚠️](#important-notice-️)
* [Migration guide 🔄](#migration-guide-)
* [Credits 👏](#credits-)
* [Report Bugs 🐛](#report-bugs-)
* [Contributors ✨](#contributors-)

## Features 🚀

* Fast execution, averaging 0-10 seconds.
* Leverages either [Github's REST API](https://docs.github.com/en/rest/reference/repos#list-commits) or [Git's native diff command](https://git-scm.com/docs/git-diff) to determine changed files.
* Facilitates easy debugging.
* Scales to handle large/mono repositories.
* Supports Git submodules.
* 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.
* 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.
* Lists changed directories.
* Limits matching changed directories to a specified maximum depth.
* 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.
* Supports fetching a fixed number of commits, which improves performance.
* 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/[email protected]/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.
* Uses [Glob pattern](https://codepen.io/mrmlnc/pen/OXQjMe) matching.
* Supports Globstar.
* Supports brace expansion.
* Supports negation.
* Uses [YAML](https://yaml.org/) syntax for specifying patterns.
* 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).

And many more...

## Usage 💻

> \[!IMPORTANT]
>
> * **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.
> * **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.
> * **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.
> * **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.

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.

### On [`pull_request`](https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#pull_request) 🔀

Detect changes to all files in a Pull request relative to the target branch or since the last pushed commit.

#### Using local .git directory 📁

```yaml
name: CI

on:
pull_request:
branches:
- main

jobs:
# ------------------------------------------------------------------------------------------------------------------------------------------------
# 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.
# ------------------------------------------------------------------------------------------------------------------------------------------------
changed_files:
runs-on: ubuntu-latest # windows-latest || macos-latest
name: Test changed-files
steps:
- uses: actions/checkout@v4

# -----------------------------------------------------------------------------------------------------------
# Example 1
# -----------------------------------------------------------------------------------------------------------
- name: Get changed files
id: changed-files
uses: tj-actions/changed-files@v45
# 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
env:
ALL_CHANGED_FILES: ${{ steps.changed-files.outputs.all_changed_files }}
run: |
for file in ${ALL_CHANGED_FILES}; do
echo "$file was changed"
done

# -----------------------------------------------------------------------------------------------------------
# Example 2
# -----------------------------------------------------------------------------------------------------------
- name: Get all changed markdown files
id: changed-markdown-files
uses: tj-actions/changed-files@v45
with:
# Avoid using single or double quotes for multiline patterns
files: |
**.md
docs/**.md

- name: List all changed files markdown files
if: steps.changed-markdown-files.outputs.any_changed == 'true'
env:
ALL_CHANGED_FILES: ${{ steps.changed-markdown-files.outputs.all_changed_files }}
run: |
for file in ${ALL_CHANGED_FILES}; do
echo "$file was changed"
done

# -----------------------------------------------------------------------------------------------------------
# Example 3
# -----------------------------------------------------------------------------------------------------------
- name: Get all test, doc and src files that have changed
id: changed-files-yaml
uses: tj-actions/changed-files@v45
with:
files_yaml: |
doc:
- '**.md'
- docs/**
test:
- test/**
- '!test/**.md'
src:
- src/**
# 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
# 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.
if: steps.changed-files-yaml.outputs.test_any_changed == 'true'
env:
TEST_ALL_CHANGED_FILES: ${{ steps.changed-files-yaml.outputs.test_all_changed_files }}
run: |
echo "One or more test file(s) has changed."
echo "List all the files that have changed: $TEST_ALL_CHANGED_FILES"

- name: Run step if doc file(s) change
if: steps.changed-files-yaml.outputs.doc_any_changed == 'true'
env:
DOC_ALL_CHANGED_FILES: ${{ steps.changed-files-yaml.outputs.doc_all_changed_files }}
run: |
echo "One or more doc file(s) has changed."
echo "List all the files that have changed: $DOC_ALL_CHANGED_FILES"

# -----------------------------------------------------------------------------------------------------------
# Example 4
# -----------------------------------------------------------------------------------------------------------
- name: Get changed files in the docs folder
id: changed-files-specific
uses: tj-actions/changed-files@v45
with:
files: docs/*.{js,html} # Alternatively using: `docs/**`
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'
env:
ALL_CHANGED_FILES: ${{ steps.changed-files-specific.outputs.all_changed_files }}
run: |
echo "One or more files in the docs folder has changed."
echo "List all the files that have changed: $ALL_CHANGED_FILES"
```

#### Using Github's API :octocat:

```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.
# - For more flexibility and no limitations see "Using local .git directory" above.

runs-on: ubuntu-latest # windows-latest || macos-latest
name: Test changed-files
permissions:
pull-requests: read

steps:
- name: Get changed files
id: changed-files
uses: tj-actions/changed-files@v45

- name: List all changed files
env:
ALL_CHANGED_FILES: ${{ steps.changed-files.outputs.all_changed_files }}
run: |
for file in ${ALL_CHANGED_FILES}; do
echo "$file was changed"
done
```

### On [`push`](https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#push) ⬆️

Detect changes to files made since the last pushed commit.

```yaml
name: CI

on:
push:
branches:
- main

jobs:
# -------------------------------------------------------------
# Using GitHub's API is not supported for push events
# -------------------------------------------------------------
#
# ----------------------------------------------------------------------------------------------
# Using local .git history
# ----------------------------------------------------------------------------------------------
# Event `push`: Compare the preceding remote commit -> to the current commit of the main branch
# ----------------------------------------------------------------------------------------------
changed_files:
runs-on: ubuntu-latest # windows-latest || macos-latest
name: Test changed-files
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0 # OR "2" -> To retrieve the preceding commit.

- name: Get changed files
id: changed-files
uses: tj-actions/changed-files@v45
# NOTE: `since_last_remote_commit: true` is implied by default and falls back to the previous local commit.

- name: List all changed files
env:
ALL_CHANGED_FILES: ${{ steps.changed-files.outputs.all_changed_files }}
run: |
for file in ${ALL_CHANGED_FILES}; do
echo "$file was changed"
done
...
```

### Other supported events :electron:

* [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)
* [workflow\_run](https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#workflow_run)
* [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

To access more examples, navigate to the [Examples](#examples-) section.

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

> \[!IMPORTANT]
>
> * When using `files_yaml*` inputs:
> * All keys must start with a letter or `_` and contain only alphanumeric characters, `-`, or `_`.
>
> For example, `test` or `test_key` or `test-key` or `_test_key` are all valid choices.

## Inputs ⚙️

```yaml
- uses: tj-actions/changed-files@v45
id: changed-files
with:
# Github API URL.
# Type: string
# Default: "${{ github.api_url }}"
api_url: ''

# Specify a different base commit
# SHA or branch used for
# comparing changes
# Type: string
base_sha: ''

# Exclude changes outside the current
# directory and show path names
# relative to it. NOTE: This
# requires you to specify the
# top-level directory via the `path`
# input.
# Type: boolean
# Default: "true"
diff_relative: ''

# Output unique changed directories instead
# of filenames. NOTE: This returns
# `.` for changed files located
# in the current working directory
# which defaults to `$GITHUB_WORKSPACE`.
# Type: boolean
# Default: "false"
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`.
# Type: boolean
# Default: "false"
dir_names_deleted_files_include_only_deleted_dirs: ''

# Exclude the current directory represented
# by `.` from the output
# when `dir_names` is set to
# `true`.
# Type: boolean
# Default: "false"
dir_names_exclude_current_dir: ''

# File and directory patterns to
# include in the output when
# `dir_names` is set to `true`.
# NOTE: This returns only the
# matching files and also the
# directory names.
# Type: string
dir_names_include_files: ''

# Separator used to split the
# `dir_names_include_files` input
# Type: string
# Default: "\n"
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`.
# Type: string
dir_names_max_depth: ''

# Escape JSON output.
# Type: boolean
# Default: "true"
escape_json: ''

# Exclude changes to submodules.
# Type: boolean
# Default: "false"
exclude_submodules: ''

# Fail when the initial diff
# fails.
# Type: boolean
# Default: "false"
fail_on_initial_diff_error: ''

# Fail when the submodule diff
# fails.
# Type: boolean
# Default: "false"
fail_on_submodule_diff_error: ''

# Fetch additional history for submodules.
# Type: boolean
# Default: "false"
fetch_additional_submodule_history: ''

# Depth of additional branch history
# fetched. NOTE: This can be
# adjusted to resolve errors with
# insufficient history.
# Type: string
# Default: "25"
fetch_depth: ''

# Maximum number of retries to
# fetch missing history.
# Type: string
# Default: "20"
fetch_missing_history_max_retries: ''

# File and directory patterns used
# to detect changes (Defaults to the entire repo if unset). NOTE:
# Multiline file/directory patterns should not
# include quotes.
# Type: string
files: ''

# Source file(s) used to populate
# the `files` input.
# Type: string
files_from_source_file: ''

# Separator used to split the
# `files_from_source_file` input.
# Type: string
# Default: "\n"
files_from_source_file_separator: ''

# Ignore changes to these file(s).
# NOTE: Multiline file/directory patterns should
# not include quotes.
# Type: string
files_ignore: ''

# Source file(s) used to populate
# the `files_ignore` input
# Type: string
files_ignore_from_source_file: ''

# Separator used to split the
# `files_ignore_from_source_file` input
# Type: string
# Default: "\n"
files_ignore_from_source_file_separator: ''

# Separator used to split the
# `files_ignore` input
# Type: string
# Default: "\n"
files_ignore_separator: ''

# YAML used to define a
# set of file patterns to
# ignore changes
# Type: string
files_ignore_yaml: ''

# 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
# Type: string
files_ignore_yaml_from_source_file: ''

# Separator used to split the
# `files_ignore_yaml_from_source_file` input
# Type: string
# Default: "\n"
files_ignore_yaml_from_source_file_separator: ''

# Separator used to split the
# `files` input
# Type: string
# Default: "\n"
files_separator: ''

# YAML used to define a
# set of file patterns to
# detect changes
# Type: string
files_yaml: ''

# Source file(s) used to populate
# the `files_yaml` input. Example: https://github.com/tj-actions/changed-files/blob/main/test/changed-files.yml
# Type: string
files_yaml_from_source_file: ''

# Separator used to split the
# `files_yaml_from_source_file` input
# Type: string
# Default: "\n"
files_yaml_from_source_file_separator: ''

# Include `all_old_new_renamed_files` output. Note this
# can generate a large output
# See: #501.
# Type: boolean
# Default: "false"
include_all_old_new_renamed_files: ''

# Output list of changed files
# in a JSON formatted string
# which can be used for
# matrix jobs. Example: https://github.com/tj-actions/changed-files/blob/main/.github/workflows/matrix-example.yml
# Type: boolean
# Default: "false"
json: ''

# 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: ''

# Apply the negation patterns first.
# NOTE: This affects how changed
# files are matched.
# Type: boolean
# Default: "false"
negation_patterns_first: ''

# Split character for old and
# new renamed filename pairs.
# Type: string
# Default: " "
old_new_files_separator: ''

# Split character for old and
# new filename pairs.
# Type: string
# Default: ","
old_new_separator: ''

# Directory to store output files.
# Type: string
# Default: ".github/outputs"
output_dir: ''

# Output renamed files as deleted
# and added files.
# Type: boolean
# Default: "false"
output_renamed_files_as_deleted_and_added: ''

# Specify a relative path under
# `$GITHUB_WORKSPACE` to locate the repository.
# Type: string
# Default: "."
path: ''

# Use non-ASCII characters to match
# files and output the filenames
# completely verbatim by setting this
# to `false`
# Type: boolean
# Default: "true"
quotepath: ''

# Recover deleted files.
# Type: boolean
# Default: "false"
recover_deleted_files: ''

# Recover deleted files to a
# new destination directory, defaults to
# the original location.
# Type: string
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.
# Type: string
recover_files: ''

# File and directory patterns to
# ignore when recovering deleted files.
# Type: string
recover_files_ignore: ''

# Separator used to split the
# `recover_files_ignore` input
# Type: string
# Default: "\n"
recover_files_ignore_separator: ''

# Separator used to split the
# `recover_files` input
# Type: string
# Default: "\n"
recover_files_separator: ''

# Apply sanitization to output filenames
# before being set as output.
# Type: boolean
# Default: "true"
safe_output: ''

# Split character for output strings.
# Type: string
# Default: " "
separator: ''

# Specify a different commit SHA
# or branch used for comparing
# changes
# Type: string
sha: ''

# Get changed files for commits
# whose timestamp is older than
# the given time.
# Type: string
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.
# Type: boolean
# Default: "false"
since_last_remote_commit: ''

# 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.
# Type: boolean
# Default: "false"
skip_initial_fetch: ''

# Tags pattern to ignore.
# Type: string
tags_ignore_pattern: ''

# Tags pattern to include.
# Type: string
# Default: "*"
tags_pattern: ''

# GitHub token used to fetch
# changed files from Github's API.
# Type: string
# Default: "${{ github.token }}"
token: ''

# Get changed files for commits
# whose timestamp is earlier than
# the given time.
# Type: string
until: ''

# Use POSIX path separator `/`
# for output file paths on
# Windows.
# Type: boolean
# Default: "false"
use_posix_path_separator: ''

# Force the use of Github's
# REST API even when a
# local copy of the repository
# exists
# Type: boolean
# Default: "false"
use_rest_api: ''

# Write outputs to the `output_dir`
# defaults to `.github/outputs` folder. NOTE:
# This creates a `.txt` file
# by default and a `.json`
# file if `json` is set
# to `true`.
# Type: boolean
# Default: "false"
write_output_files: ''

```

## Useful Acronyms 🧮

| Acronym | Meaning |
|:---------:|:------------:|
| A | Added |
| C | Copied |
| M | Modified |
| D | Deleted |
| R | Renamed |
| T | Type changed |
| U | Unmerged |
| X | Unknown |

> \[!IMPORTANT]
>
> * When using `files_yaml*` inputs:
> * it's required to prefix all outputs with the key to ensure that the correct outputs are accessible.
>
> 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.

## Outputs 📤

| OUTPUT
|----------------------------------------------------------------------------------------------------------------------
| [added\_files](#output_added_files)
| [added\_files\_count](#output_added_files_count)
| [all\_changed\_and\_modified\_files](#output_all_changed
| [all\_changed\_and\_modified\_files\_count](#output_all_cha
| [all\_changed\_files](#output_all_changed_files)
| [all\_changed\_files\_count](#output_all_changed_files_count)
| [all\_modified\_files](#output_all_modified_files)
| [all\_modified\_files\_count](#output_all_modified_files_count)
| [all\_old\_new\_renamed\_files](#output_all_old_new_renamed_files)
| [all\_old\_new\_renamed\_files\_count](#output_all_old_ne
| [any\_changed](#output_any_changed)
| [any\_deleted](#output_any_deleted)
| [any\_modified](#output_any_modified)
| [changed\_keys](#output_changed_keys)
| [copied\_files](#output_copied_files)
| [copied\_files\_count](#output_copied_files_count)
| [deleted\_files](#output_deleted_files)
| [deleted\_files\_count](#output_deleted_files_count)
| [modified\_files](#output_modified_files)
| [modified\_files\_count](#output_modified_files_count)
| [modified\_keys](#output_modified_keys)
| [only\_changed](#output_only_changed)
| [only\_deleted](#output_only_deleted)
| [only\_modified](#output_only_modified)
| [other\_changed\_files](#output_other_changed_files)
| [other\_changed\_files\_count](#output_other_changed_files_count)
| [other\_deleted\_files](#output_other_deleted_files)
| [other\_deleted\_files\_count](#output_other_deleted_files_count)
| [other\_modified\_files](#output_other_modified_files)
| [other\_modified\_files\_count](#output_other_modified_files_count)
| [renamed\_files](#output_renamed_files)
| [renamed\_files\_count](#output_renamed_files_count)
| [type\_changed\_files](#output_type_changed_files)
| [type\_changed\_files\_count](#output_type_changed_files_count)
| [unknown\_files](#output_unknown_files)
| [unknown\_files\_count](#output_unknown_files_count)
| [unmerged\_files](#output_unmerged_files)
| [unmerged\_files\_count](#output_unmerged_files_count) | TYPE | DESCRIPTION | --------------------------|--------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | string | Returns only files that are
Added (A). | | string | Returns the number of `added_files` | _and_modified_files) | string | Returns all changed and modified
files i.e. a combination of
(ACMRDTUX) | nged_and_modified_files_count) | string | Returns the number of `all_changed_and_modified_files` | | string | Returns all changed files i.e.
a combination of all added,
copied, modified and renamed files
(ACMR) | | string | Returns the number of `all_changed_files` | | string | Returns all changed files i.e.
a combination of all added,
copied, modified, renamed and deleted
files (ACMRD). | | string | Returns the number of `all_modified_files` | | string | Returns only files that are
Renamed and lists their old
and new names. **NOTE:** This
requires setting `include_all_old_new_renamed_files` to `true`.
Also, keep in mind that
this output is global and
wouldn't be nested in outputs
generated when the `*_yaml_*` input
is used. (R) | w_renamed_files_count) | string | Returns the number of `all_old_new_renamed_files` | | string | Returns `true` when any of
the filenames provided using the
`files*` or `files_ignore*` inputs have changed. This
defaults to `true` when no
patterns are specified. i.e. *includes a combination of all added, copied, modified and renamed files (ACMR)*. | | string | Returns `true` when any of
the filenames provided using the
`files*` or `files_ignore*` inputs have been deleted.
This defaults to `true` when
no patterns are specified. (D) | | string | Returns `true` when any of
the filenames provided using the
`files*` or `files_ignore*` inputs have been modified.
This defaults to `true` when
no patterns are specified. i.e.
*includes a combination of all added, copied, modified, renamed, and deleted files (ACMRD)*. | | string | Returns all changed YAML keys
when the `files_yaml` input is
used. i.e. key that contains
any path that has either
been added, copied, modified, and
renamed (ACMR) | | string | Returns only files that are
Copied (C). | | string | Returns the number of `copied_files` | | string | Returns only files that are
Deleted (D). | | string | Returns the number of `deleted_files` | | string | Returns only files that are
Modified (M). | | string | Returns the number of `modified_files` | | string | Returns all modified YAML keys
when the `files_yaml` input is
used. i.e. key that contains
any path that has either
been added, copied, modified, and
deleted (ACMRD) | | string | Returns `true` when only files
provided using the `files*` or `files_ignore*` inputs
have changed. i.e. *includes a combination of all added, copied, modified and renamed files (ACMR)*. | | string | Returns `true` when only files
provided using the `files*` or `files_ignore*` inputs
have been deleted. (D) | | string | Returns `true` when only files
provided using the `files*` or `files_ignore*` inputs
have been modified. (ACMRD). | | string | Returns all other changed files
not listed in the files
input i.e. includes a combination
of all added, copied, modified
and renamed files (ACMR). | | string | Returns the number of `other_changed_files` | | string | Returns all other deleted files
not listed in the files
input i.e. a combination of
all deleted files (D) | | string | Returns the number of `other_deleted_files` | | string | Returns all other modified files
not listed in the files
input i.e. a combination of
all added, copied, modified, and
deleted files (ACMRD) | | string | Returns the number of `other_modified_files` | | string | Returns only files that are
Renamed (R). | | string | Returns the number of `renamed_files` | | string | Returns only files that have
their file type changed (T). | | string | Returns the number of `type_changed_files` | | string | Returns only files that are
Unknown (X). | | string | Returns the number of `unknown_files` | | string | Returns only files that are
Unmerged (U). | | string | Returns the number of `unmerged_files` |

## Versioning 🏷️

This GitHub Action follows the principles of [Semantic Versioning](https://semver.org) for versioning releases.

The format of the version string is as follows:

* major: indicates significant changes or new features that may not be backward compatible.

* minor: indicates minor changes or new features that are backward compatible.

* patch: indicates bug fixes or other small changes that are backward compatible.

## Examples 📄

Get all changed files in the current branch

```yaml
...
- name: Get changed files
id: changed-files
uses: tj-actions/changed-files@v45
...
```

Get all changed files without escaping unsafe filename characters

```yaml
...
- name: Get changed files
id: changed-files
uses: tj-actions/changed-files@v45
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: |
for file in ${ADDED_FILES}; do
echo "$file was added"
done
...
```

Get all changed files and use a comma separator

```yaml
...
- name: Get all changed files and use a comma separator in the output
id: changed-files
uses: tj-actions/changed-files@v45
with:
separator: ","
...
```

See [inputs](#inputs) for more information.

Get all changed files and list all added files

```yaml
...
- name: Get changed files
id: changed-files
uses: tj-actions/changed-files@v45

- name: List all added files
env:
ADDED_FILES: ${{ steps.changed-files.outputs.added_files }}
run: |
for file in ${ADDED_FILES}; do
echo "$file was added"
done
...
```

See [outputs](#outputs) for a list of all available outputs.

Get all changed files and optionally run a step if a file was modified

```yaml
...
- name: Get changed files
id: changed-files
uses: tj-actions/changed-files@v45

- 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."
...
```

See [outputs](#outputs) for a list of all available outputs.

Get all changed files and write the outputs to a txt file

```yaml
...

- name: Get changed files and write the outputs to a Txt file
id: changed-files-write-output-files-txt
uses: tj-actions/changed-files@v45
with:
write_output_files: true

- name: Verify the contents of the .github/outputs/added_files.txt file
run: |
cat .github/outputs/added_files.txt
...
```

Get all changed files and write the outputs to a json file

```yaml
...
- name: Get changed files and write the outputs to a JSON file
id: changed-files-write-output-files-json
uses: tj-actions/changed-files@v45
with:
json: true
write_output_files: true

- name: Verify the contents of the .github/outputs/added_files.json file
run: |
cat .github/outputs/added_files.json
...
```

Get all changed files using a list of files

```yaml
...
- name: Get changed files
id: changed-files
uses: tj-actions/changed-files@v45
with:
files: |
my-file.txt
*.sh
*.png
!*.md
test_directory/**
**/*.sql
...
```

See [inputs](#inputs) for more information.

Get all changed files using a list of files and take action based on the changes

```yaml
...
- name: Get changed files
id: changed-files-specific
uses: tj-actions/changed-files@v45
with:
files: |
my-file.txt
*.sh
*.png
!*.md
test_directory/**
**/*.sql

- 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
if: steps.changed-files-specific.outputs.any_deleted == 'true'
env:
DELETED_FILES: ${{ steps.changed-files-specific.outputs.deleted_files }}
run: |
for file in ${DELETED_FILES}; do
echo "$file was deleted"
done

- name: Run step if all listed files above have been deleted
if: steps.changed-files-specific.outputs.only_deleted == 'true'
env:
DELETED_FILES: ${{ steps.changed-files-specific.outputs.deleted_files }}
run: |
for file in ${DELETED_FILES}; do
echo "$file was deleted"
done
...
```

See [outputs](#outputs) for a list of all available outputs.

Get all changed files using a source file or list of file(s) to populate to files input

```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
uses: tj-actions/changed-files@v45
with:
files_from_source_file: test/changed-files-list.txt
...
```

See [inputs](#inputs) for more information.

Get changed files using a source file or list of file(s) to populate to files input and optionally specify more files

```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
uses: tj-actions/changed-files@v45
with:
files_from_source_file: |
test/changed-files-list.txt
files: |
test.txt
...
```

See [inputs](#inputs) for more information.

Get all changed files using a different SHA

```yaml
...
- name: Get changed files using a different SHA
id: changed-files
uses: tj-actions/changed-files@v45
with:
sha: ${{ github.event.pull_request.head.sha }}
...
```

See [inputs](#inputs) for more information.

Get all changed files using a different base SHA

```yaml
...
- name: Get changed files using a different base SHA
id: changed-files
uses: tj-actions/changed-files@v45
with:
base_sha: ${{ github.event.pull_request.base.sha }}
...
```

See [inputs](#inputs) for more information.

Get all changed files between the previous tag and the current tag

```yaml
...
on:
push:
tags:
- 'v*'

jobs:
release:
name: Release
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
with:
fetch-depth: 0

- name: Get changed files
id: changed-files
uses: tj-actions/changed-files@v45

- 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"

- name: Get changed files in the .github folder
id: changed-files-specific
uses: tj-actions/changed-files@v45
with:
files: .github/**

- name: Run step if any file(s) in the .github folder change
if: steps.changed-files-specific.outputs.any_changed == 'true'
env:
ALL_CHANGED_FILES: ${{ steps.changed-files-specific.outputs.all_changed_files }}
run: |
echo "One or more files in the .github folder has changed."
echo "List all the files that have changed: $ALL_CHANGED_FILES"
...
```

See [inputs](#inputs) for more information.

Get all changed files for a repository located in a different path

```yaml
...
- name: Checkout into dir1
uses: actions/checkout@v4
with:
fetch-depth: 0
path: dir1

- name: Run changed-files with defaults in dir1
id: changed-files-for-dir1
uses: tj-actions/changed-files@v45
with:
path: dir1

- name: List all added files in dir1
env:
ADDED_FILES: ${{ steps.changed-files-for-dir1.outputs.added_files }}
run: |
for file in ${ADDED_FILES}; do
echo "$file was added"
done
...
```

See [inputs](#inputs) for more information.

Get all changed files with non-äšćįí characters i.e (Filename in other languages)

```yaml
...
- name: Run changed-files with quotepath disabled
id: changed-files-quotepath
uses: tj-actions/changed-files@v45
with:
quotepath: "false"

- name: Run changed-files with quotepath disabled for a specified list of file(s)
id: changed-files-quotepath-specific
uses: tj-actions/changed-files@v45
with:
files: test/test-è.txt
quotepath: "false"
...
```

See [inputs](#inputs) for more information.

Get all changed files using the last successful commit of the base branch

Push event

```yaml
...
- name: Get branch name
id: branch-name
uses: tj-actions/branch-names@v6

- uses: nrwl/nx-set-shas@v3
id: last_successful_commit_push
with:
main-branch-name: ${{ steps.branch-name.outputs.current_branch }} # Get the last successful commit for the current branch.
workflow-id: 'test.yml'

- name: Run changed-files with the commit of the last successful test workflow run
id: changed-files-base-sha-push
uses: tj-actions/changed-files@v45
with:
base_sha: ${{ steps.last_successful_commit_push.outputs.base }}
...
```

Pull request events

```yaml
...
- name: Get branch name
id: branch-name
uses: tj-actions/branch-names@v5

- uses: nrwl/nx-set-shas@v3
id: last_successful_commit_pull_request
with:
main-branch-name: ${{ steps.branch-name.outputs.base_ref_branch }} # Get the last successful commit on the master or main branch
workflow_id: 'test.yml'

- name: Run changed-files with the commit of the last successful test workflow run on the main branch
id: changed-files-base-sha-pull-request
uses: tj-actions/changed-files@v45
with:
base_sha: ${{ steps.last_successful_commit_pull_request.outputs.base }}
...
```

> **Warning**
>
> This setting overrides the commit sha used by setting `since_last_remote_commit` to true.
> It is recommended to use either solution that works for your use case.

See [inputs](#inputs) for more information.

Get all changed files but only return the directory names

```yaml
...
- name: Run changed-files with dir_names
id: changed-files-dir-names
uses: tj-actions/changed-files@v45
with:
dir_names: "true"
...
```

See [inputs](#inputs) for more information.

Get all changed files and return JSON formatted outputs

```yaml
...
- name: Run changed-files with JSON output
id: changed-files-json
uses: tj-actions/changed-files@v45
with:
json: "true"
...
```

See [inputs](#inputs) for more information.

Get all changed files by commits pushed in the past

```yaml
...
- name: Get changed-files since 2022-08-19
id: changed-files-since
uses: tj-actions/changed-files@v45
with:
since: "2022-08-19"

- name: Get changed-files until 2022-08-20
id: changed-files-until
uses: tj-actions/changed-files@v45
with:
until: "2022-08-20"
...
```

See [inputs](#inputs) for more information.

## Real-world usage 🌐

### Open source projects 📦

* [vitejs/vite: uses tj-actions/changed-files to automate testing](https://github.com/vitejs/vite/blob/8da04227d6f818a8ad9efc0056101968037c2e36/.github/workflows/ci.yml#L61)

* [qgis/QGIS: uses tj-actions/changed-files to automate spell checking](https://github.com/qgis/QGIS/blob/a5333497e90ac9de4ca70463d8e0b64c3f294d63/.github/workflows/code_layout.yml#L147)

* [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)

* [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)

* [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)

* [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)

* [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)

* [qmk\_firmware uses tj-actions/changed-files to run linters](https://github.com/qmk/qmk_firmware/blob/7a737235ffd49c32d2c5561e8fe53fd96baa7f96/.github/workflows/lint.yml#L30)

* [argo-cd uses tj-actions/changed-files to detect changed frontend or backend files](https://github.com/argoproj/argo-cd/blob/5bc1850aa1d26301043be9f2fb825d88c80c111c/.github/workflows/ci-build.yaml#L33)

* [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)

And many more...

### Scalability Example 📈

![image](https://github.com/tj-actions/changed-files/assets/17484350/23767413-4c51-42fb-ab1c-39ef72c44904)

## Important Notice ⚠️

> \[!IMPORTANT]
>
> * Spaces in file names can introduce bugs when using bash loops. See: [#216](https://github.com/tj-actions/changed-files/issues/216)
> However, this action will handle spaces in file names, with a recommendation of using a separator to prevent any hidden issues.
>
> ![Screen Shot 2021-10-23 at 9 37 34 AM](https://user-images.githubusercontent.com/17484350/138558767-b13c90bf-a1ae-4e86-9520-70a6a4624f41.png)

## Migration guide 🔄

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`.

```diff
...
- name: Get specific changed files
id: changed-files-specific
uses: tj-actions/changed-files@v24
with:
files: |
- \.sh$
- .(sql|py)$
- ^(dir1|dir2)
+ **/*.{sh,sql,py}
+ {dir1,dir2}/**
```

* Free software: [MIT license](LICENSE)

## Credits 👏

This package was created with [cookiecutter-action](https://github.com/tj-actions/cookiecutter-action).

* [tj-actions/auto-doc](https://github.com/tj-actions/auto-doc)
* [tj-actions/verify-changed-files](https://github.com/tj-actions/verify-changed-files)
* [tj-actions/demo](https://github.com/tj-actions/demo)
* [tj-actions/demo2](https://github.com/tj-actions/demo2)
* [tj-actions/demo3](https://github.com/tj-actions/demo3)
* [tj-actions/release-tagger](https://github.com/tj-actions/release-tagger)

## Report Bugs 🐛

Report bugs at https://github.com/tj-actions/changed-files/issues.

If you are reporting a bug, please include:

* Your operating system name and version.
* All essential details about your workflow that might be helpful in troubleshooting. (**NOTE**: Ensure that you include full log outputs with debugging enabled)
* Detailed steps to reproduce the bug.

## Contributors ✨

Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):

_{Josh Soref}
📖

_{Nick Landers}
💻

_{Krasimir Nikolov}
💻 📖

_{Ivan Pizhenko}
💻 📖

_talva-tr
💻

_{Ikko Ashimine}
📖

_James
📖

_{James Cheng}
📖

_{Masaya Suzuki}
💻

_fagai
📖

_{Constantine Peresypkin}
💻

_{Mathieu Dupuy}
📖

_{Joe Moggridge}
📖

_{Charles Santos}
💻

_{Kostiantyn Korniienko}
📖

_{Logan Pulley}
💻

_{Kenji Miyake}
💻

_{adonisgarciac}
💻 📖

_{Chiel Fernhout}
📖

_{Alberto Perdomo}
📖

_Arthur
🐛 💻

_{Rodrigo Fior Kuntzer}
💻 ⚠️ 🐛

_{Aleksey Levenstein}
📖

_{Daniel Hill}
📖

_{KeisukeYamashita}
📖

_Aravind
💻 🐛

_{Lukas Pfahler}
💻