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

Ubuntu Mac OS Windows Public workflows that use this action.

Codacy Badge CI

All Contributors

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

Table of contents

Features ๐Ÿš€

And many more...

Usage ๐Ÿ’ป

Important

Visit the discussions for more information or create a new discussion for usage-related questions.

On 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 ๐Ÿ“

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@9426d40962ed5378910ee2e21d5f8c6fcbf2dd96 # v47.0.6
    # 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@9426d40962ed5378910ee2e21d5f8c6fcbf2dd96 # v47.0.6
    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@9426d40962ed5378910ee2e21d5f8c6fcbf2dd96 # v47.0.6
    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@9426d40962ed5378910ee2e21d5f8c6fcbf2dd96 # v47.0.6
    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:

name: CI

on: pull_request: branches: - main merge_group:

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@9426d40962ed5378910ee2e21d5f8c6fcbf2dd96 # v47.0.6

  - 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 โฌ†๏ธ

Detect changes to files made since the last pushed commit.

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@9426d40962ed5378910ee2e21d5f8c6fcbf2dd96 # v47.0.6
  # 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:

To access more examples, navigate to the Examples section.

If you feel generous and want to show some extra appreciation:

Support this project with a โญ

Buy me a coffee

Important

Inputs โš™๏ธ

Useful Acronyms ๐Ÿงฎ

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

Important

Outputs ๐Ÿ“ค

OUTPUT TYPE DESCRIPTION
added_files string Returns only files that are Added (A).
added_files_count string Returns the number of added_files
all_changed_and_modified_files string Returns all changed and modified files i.e. a combination of (ACMRDTUX)
all_changed_and_modified_files_count string Returns the number of all_changed_and_modified_files
all_changed_files string Returns all changed files i.e. a combination of all added, copied, modified and renamed files (ACMR)
all_changed_files_count string Returns the number of all_changed_files
all_modified_files string Returns all changed files i.e. a combination of all added, copied, modified, renamed and deleted files (ACMRD).
all_modified_files_count string Returns the number of all_modified_files
all_old_new_renamed_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)
all_old_new_renamed_files_count string Returns the number of all_old_new_renamed_files
any_added string Returns true when any of the filenames provided using the files* or files_ignore* inputs have been added.
any_changed 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).
any_deleted 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)
any_modified 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).
changed_keys 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)
copied_files string Returns only files that are Copied (C).
copied_files_count string Returns the number of copied_files
deleted_files string Returns only files that are Deleted (D).
deleted_files_count string Returns the number of deleted_files
modified_files string Returns only files that are Modified (M).
modified_files_count string Returns the number of modified_files
modified_keys 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)
only_changed 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).
only_deleted string Returns true when only files provided using the files* or files_ignore* inputs have been deleted. (D)
only_modified string Returns true when only files provided using the files* or files_ignore* inputs have been modified. (ACMRD).
other_changed_files 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).
other_changed_files_count string Returns the number of other_changed_files
other_deleted_files string Returns all other deleted files not listed in the files input i.e. a combination of all deleted files (D)
other_deleted_files_count string Returns the number of other_deleted_files
other_modified_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)
other_modified_files_count string Returns the number of other_modified_files
renamed_files string Returns only files that are Renamed (R).
renamed_files_count string Returns the number of renamed_files
type_changed_files string Returns only files that have their file type changed (T).
type_changed_files_count string Returns the number of type_changed_files
unknown_files string Returns only files that are Unknown (X).
unknown_files_count string Returns the number of unknown_files
unmerged_files string Returns only files that are Unmerged (U).
unmerged_files_count string Returns the number of unmerged_files

Versioning ๐Ÿท๏ธ

This GitHub Action follows the principles of Semantic Versioning for versioning releases.

The format of the version string is as follows:

Examples ๐Ÿ“„

Get all changed files in the current branch

... - name: Get changed files id: changed-files uses: tj-actions/changed-files@9426d40962ed5378910ee2e21d5f8c6fcbf2dd96 # v47.0.6 ...

Get all changed files without escaping unsafe filename characters

... - name: Get changed files id: changed-files uses: tj-actions/changed-files@9426d40962ed5378910ee2e21d5f8c6fcbf2dd96 # v47.0.6 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

... - name: Get all changed files and use a comma separator in the output id: changed-files uses: tj-actions/changed-files@9426d40962ed5378910ee2e21d5f8c6fcbf2dd96 # v47.0.6 with: separator: "," ...

See inputs for more information.

Get all changed files and list all added files

... - name: Get changed files id: changed-files uses: tj-actions/changed-files@9426d40962ed5378910ee2e21d5f8c6fcbf2dd96 # v47.0.6

- 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 for a list of all available outputs.

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

... - name: Get changed files id: changed-files uses: tj-actions/changed-files@9426d40962ed5378910ee2e21d5f8c6fcbf2dd96 # v47.0.6

- 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 for a list of all available outputs.

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

...

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

...

Get all changed files using a list of files

... - name: Get changed files id: changed-files uses: tj-actions/changed-files@9426d40962ed5378910ee2e21d5f8c6fcbf2dd96 # v47.0.6 with: files: | my-file.txt .sh .png !.md test_directory/* **/*.sql ...

See inputs for more information.

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

... - name: Get changed files id: changed-files-specific uses: tj-actions/changed-files@9426d40962ed5378910ee2e21d5f8c6fcbf2dd96 # v47.0.6 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 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

... - 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@9426d40962ed5378910ee2e21d5f8c6fcbf2dd96 # v47.0.6 with: files_from_source_file: test/changed-files-list.txt ...

See 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

... - 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@9426d40962ed5378910ee2e21d5f8c6fcbf2dd96 # v47.0.6 with: files_from_source_file: | test/changed-files-list.txt files: | test.txt ...

See inputs for more information.

Get all changed files using a different SHA

... - name: Get changed files using a different SHA id: changed-files uses: tj-actions/changed-files@9426d40962ed5378910ee2e21d5f8c6fcbf2dd96 # v47.0.6 with: sha: ${{ github.event.pull_request.head.sha }} ...

See inputs for more information.

Get all changed files using a different base SHA

... - name: Get changed files using a different base SHA id: changed-files uses: tj-actions/changed-files@9426d40962ed5378910ee2e21d5f8c6fcbf2dd96 # v47.0.6 with: base_sha: ${{ github.event.pull_request.base.sha }} ...

See inputs for more information.

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

... 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@9426d40962ed5378910ee2e21d5f8c6fcbf2dd96 # v47.0.6

  - 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@9426d40962ed5378910ee2e21d5f8c6fcbf2dd96 # v47.0.6
    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 for more information.

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

... - 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@9426d40962ed5378910ee2e21d5f8c6fcbf2dd96 # v47.0.6
  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 for more information.

Get all changed files with non-รคลกฤ‡ฤฏรญ characters i.e (Filename in other languages)

... - name: Run changed-files with quotepath disabled id: changed-files-quotepath uses: tj-actions/changed-files@9426d40962ed5378910ee2e21d5f8c6fcbf2dd96 # v47.0.6 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@9426d40962ed5378910ee2e21d5f8c6fcbf2dd96 # v47.0.6
  with:
    files: test/test-รจ.txt
    quotepath: "false"

...

See inputs for more information.

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

...

...

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 for more information.

Get all changed files but only return the directory names

... - name: Run changed-files with dir_names id: changed-files-dir-names uses: tj-actions/changed-files@9426d40962ed5378910ee2e21d5f8c6fcbf2dd96 # v47.0.6 with: dir_names: "true" ...

See inputs for more information.

Get all changed files and return JSON formatted outputs

... - name: Run changed-files with JSON output id: changed-files-json uses: tj-actions/changed-files@9426d40962ed5378910ee2e21d5f8c6fcbf2dd96 # v47.0.6 with: json: "true" ...

See inputs for more information.

Get all changed files by commits pushed in the past

... - name: Get changed-files since 2022-08-19 id: changed-files-since uses: tj-actions/changed-files@9426d40962ed5378910ee2e21d5f8c6fcbf2dd96 # v47.0.6 with: since: "2022-08-19"

- name: Get changed-files until 2022-08-20
  id: changed-files-until
  uses: tj-actions/changed-files@9426d40962ed5378910ee2e21d5f8c6fcbf2dd96 # v47.0.6
  with:
    until: "2022-08-20"

...

See inputs for more information.

Real-world usage ๐ŸŒ

Open source projects ๐Ÿ“ฆ

And many more...

Scalability Example ๐Ÿ“ˆ

image

Important Notice โš ๏ธ

Important

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 you'll need to modify patterns used to match files.

... - name: Get specific changed files id: changed-files-specific uses: tj-actions/changed-files@v24 with: files: |

Credits ๐Ÿ‘

This package was created with cookiecutter-action.

Report Bugs ๐Ÿ›

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

If you are reporting a bug, please include:

Contributors โœจ

Thanks goes to these wonderful people (emoji key):

Josh Soref Josh Soref๐Ÿ“– Nick Landers Nick Landers๐Ÿ’ป Krasimir Nikolov Krasimir Nikolov๐Ÿ’ป ๐Ÿ“– Ivan Pizhenko Ivan Pizhenko๐Ÿ’ป ๐Ÿ“– talva-tr talva-tr๐Ÿ’ป Ikko Ashimine Ikko Ashimine๐Ÿ“– James James๐Ÿ“–
James Cheng James Cheng๐Ÿ“– Masaya Suzuki Masaya Suzuki๐Ÿ’ป fagai fagai๐Ÿ“– Constantine Peresypkin Constantine Peresypkin๐Ÿ’ป Mathieu Dupuy Mathieu Dupuy๐Ÿ“– Joe Moggridge Joe Moggridge๐Ÿ“– Charles Santos Charles Santos๐Ÿ’ป
Kostiantyn Korniienko Kostiantyn Korniienko๐Ÿ“– Logan Pulley Logan Pulley๐Ÿ’ป Kenji Miyake Kenji Miyake๐Ÿ’ป adonisgarciac adonisgarciac๐Ÿ’ป ๐Ÿ“– Chiel Fernhout Chiel Fernhout๐Ÿ“– Alberto Perdomo Alberto Perdomo๐Ÿ“– Arthur Arthur๐Ÿ› ๐Ÿ’ป
Rodrigo Fior Kuntzer Rodrigo Fior Kuntzer๐Ÿ’ป โš ๏ธ ๐Ÿ› Aleksey Levenstein Aleksey Levenstein๐Ÿ“– Daniel Hill Daniel Hill๐Ÿ“– KeisukeYamashita KeisukeYamashita๐Ÿ“– Aravind Aravind๐Ÿ’ป ๐Ÿ› Lukas Pfahler Lukas Pfahler๐Ÿ’ป Rajendra Pandey Rajendra Pandey๐Ÿ“–
undefined undefined๐Ÿ“– Jellyfrog Jellyfrog๐Ÿ’ป ๐Ÿ“– Nelson Wolf Nelson Wolf๐Ÿ’ป โš ๏ธ

This project follows the all-contributors specification. Contributions of any kind welcome!

๐Ÿ’ผ Automate Your Job Search Too

You automate your CI/CD. Automate your job applications too.

ApplySmart AI helps you:

Free tier available โ†’ applysmart.ai