Ecosyste.ms: Awesome

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

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

:octocat: Github action to verify file changes that occur during the workflow execution.
https://github.com/tj-actions/verify-changed-files

actions automation change-detection changed-file detects-files github github-actions release-automation verify workflow workflow-execution workflows

Last synced: 16 days ago
JSON representation

:octocat: Github action to verify file changes that occur during the workflow execution.

Host: GitHub
URL: https://github.com/tj-actions/verify-changed-files
Owner: tj-actions
License: mit
Created: 2020-06-18T16:48:11.000Z (about 4 years ago)
Default Branch: main
Last Pushed: 2024-04-12T10:04:18.000Z (3 months ago)
Last Synced: 2024-04-14T01:46:21.611Z (2 months ago)
Topics: actions, automation, change-detection, changed-file, detects-files, github, github-actions, release-automation, verify, workflow, workflow-execution, workflows
Language: Shell
Homepage:
Size: 584 KB
Stars: 137
Watchers: 4
Forks: 21
Open Issues: 3
Metadata Files:
- Readme: README.md
- Changelog: HISTORY.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md

Lists

my-awesome-stars - tj-actions/verify-changed-files - :octocat: Github action to verify file changes that occur during the workflow execution. (Shell)

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%2Fverify-changed-files%26badge%3Dtrue)](https://github.com/search?o=desc\&q=tj-actions+verify-changed-files+language%3AYAML\&s=\&type=Code)

[![Codacy Badge](https://app.codacy.com/project/badge/Grade/ef128a4f001846f8a5a50316c8d3c5c3)](https://app.codacy.com/gh/tj-actions/verify-changed-files/dashboard?utm_source=gh\&utm_medium=referral\&utm_content=\&utm_campaign=Badge_grade)
[![CI](https://github.com/tj-actions/verify-changed-files/workflows/CI/badge.svg)](https://github.com/tj-actions/verify-changed-files/actions?query=workflow%3ACI)
[![Update release version.](https://github.com/tj-actions/verify-changed-files/workflows/Update%20release%20version./badge.svg)](https://github.com/tj-actions/verify-changed-files/actions?query=workflow%3A%22Update+release+version.%22)

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

# verify-changed-files

Verify that certain files or directories did or did not change during the workflow execution.

> \[!NOTE]
>
> * This action only detects files that have pending uncommitted changes generated during the workflow execution, for running a specific step when a file changes in a pull request or based on a pushed commit
>
> See: https://github.com/tj-actions/changed-files instead

## Features

* Fast execution (0-2 seconds on average).
* Easy to debug.
* Scales to large repositories.
* Supports all platforms (Linux, MacOS, Windows).
* [GitHub-hosted runners](https://docs.github.com/en/actions/using-github-hosted-runners/about-github-hosted-runners) support
* [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) support.
* [self-hosted runners](https://docs.github.com/en/actions/hosting-your-own-runners/about-self-hosted-runners) support.
* Boolean output for detecting uncommitted changes.
* List all files that changed during the workflow execution.
* Detect changes to track and untracked files.
* Restrict change detection to a subset of files:
* Using [Glob pattern](https://docs.github.com/en/actions/learn-github-actions/workflow-syntax-for-github-actions#filter-pattern-cheat-sheet) matching.
* Supports Globstar.
* Supports brace expansion.
* Supports negation.

## Usage

```yaml
...
steps:
- uses: actions/checkout@v4

- name: Change text file
run: |
echo "Modified" > new.txt

- name: Change file in directory
run: |
echo "Changed" > test_directory/new.txt

- name: Verify Changed files
uses: tj-actions/verify-changed-files@v20
id: verify-changed-files
with:
files: |
*.txt
test_directory
action.yml
**/*.{jpeg,py}
!*.sql

- name: Run step only when any of the above files change.
if: steps.verify-changed-files.outputs.files_changed == 'true'
env:
CHANGED_FILES: ${{ steps.verify-changed-files.outputs.changed_files }}
run: |
echo "Changed files: $CHANGED_FILES"
# Outputs: "Changed files: new.txt test_directory/new.txt"
```

### Using the [`contains`](https://docs.github.com/en/actions/learn-github-actions/expressions#contains) function.

```yaml
...
- name: Verify Changed files
uses: tj-actions/verify-changed-files@v20
id: verify-changed-files
with:
files: |
new.txt
test_directory

- name: Perform action when test_directory changes
if: contains(steps.verify-changed-files.outputs.changed_files, 'test_directory')
run: |
echo "test_directory has changed."
```

### Get all unstaged (tracked/untracked) files

```yaml
...
- name: Verify Changed files
uses: tj-actions/verify-changed-files@v20
id: verify-changed-files

- name: List all changed tracked and untracked files
env:
CHANGED_FILES: ${{ steps.verify-changed-files.outputs.changed_files }}
run: |
echo "Changed files: $CHANGED_FILES"
```

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

## Inputs

```yaml
- uses: tj-actions/verify-changed-files@v20
id: verify-changed-files
with:
# Indicates whether to fail if
# files have changed.
# Type: boolean
# Default: "false"
fail-if-changed: ''

# Indicates whether to fail if
# no files have changed.
# Type: boolean
# Default: "false"
fail-if-unchanged: ''

# Message to display when `fail-if-changed`
# or `fail-if-unchanged` is set to
# `true`.
# Type: string
fail-message: ''

# File/Directory names to check for
# uncommited changes.
# Type: string
files: ''

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

# Indicates whether to match files
# in `.gitignore`
# Type: boolean
# Default: "false"
match-gitignore-files: ''

# Relative path under GITHUB_WORKSPACE to
# 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: ''

# Indicates whether to read `.gitignore`.
# The `.gitignore` file will be
# ignored if set to `false`.
# Overrides `match-gitignore-files`
# Type: boolean
# Default: "false"
read-gitignore: ''

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

# Output string separator.
# Type: string
# Default: " "
separator: ''

```

## Outputs

| OUTPUT | TYPE | DESCRIPTION |
|---------------------------------------------------------------------------|--------|--------------------------------------------------|
| [changed\_files](#output_changed_files) | string | List of changed files |
| [files\_changed](#output_files_changed) | string | Boolean indicating that files have
changed. |

* Free software: [MIT license](LICENSE)

## Known Limitation

> \[!WARNING]
>
> * Using characters like `\n`, `%`, `.` and `\r` as output string separators would be [URL encoded](https://www.w3schools.com/tags/ref_urlencode.asp)

## Report Bugs

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

If you are reporting a bug, please include:

* Your operating system name and version.
* Any details about your workflow that might be helpful in troubleshooting.
* Detailed steps to reproduce the bug.

## Contributors ✨

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

_{Max Kahnt}
📖

_{William Killerud}
💻

_{Minecraftschurli}
💻 📖 ⚠️

_{Stefan Hoth}
💻

_{Raphael Boidol}
📖

_Lars
💻 ⚠️ 📖

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!