verify-changed-files

所属分类:collect
开发工具:Shell
文件大小:0KB
下载次数:0
上传日期:2023-07-18 11:49:17
上 传 者sh-1993
说明:  ![:octocat:](https:github.githubassets.com images icons emoji octocat.png)github操作,用于验证工作流执行期间发生的文件更改。,
(![:octocat:](https: github.githubassets.com images icons emoji octocat.png) Github action to verify file changes that occur during the workflow execution.,)

文件列表:
.all-contributorsrc (1356, 2023-12-28)
.whitesource (214, 2023-12-28)
CODE_OF_CONDUCT.md (5218, 2023-12-28)
HISTORY.md (136714, 2023-12-28)
LICENSE (1067, 2023-12-28)
SECURITY.md (2796, 2023-12-28)
action.yml (2469, 2023-12-28)
entrypoint.sh (3239, 2023-12-28)
renovate.json (1057, 2023-12-28)
test/ (0, 2023-12-28)
test/new.py (32, 2023-12-28)
test/new.sql (22, 2023-12-28)
test/new.txt (10, 2023-12-28)
test/new/ (0, 2023-12-28)
test/new/new.jpg (1, 2023-12-28)
test/new/new.sql (1, 2023-12-28)

[![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://api.codacy.com/project/badge/Grade/a3bbaf5dc7534b4a9bf9eaef49e41b34)](https://app.codacy.com/gh/tj-actions/verify-changed-files?utm_source=github.com\&utm_medium=referral\&utm_content=tj-actions/verify-changed-files\&utm_campaign=Badge_Grade_Settings) [![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-4-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 ## 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/enterprise-server@3.3/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-github-actions-for-github-enterprise-server) support. * [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@v2 - 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@v16 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' run: | echo "Changed files: ${{ steps.verify-changed-files.outputs.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@v16 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@v16 id: verify-changed-files - name: List all changed files tracked and untracked files run: | echo "Changed files: ${{ steps.verify-changed-files.outputs.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@v16 id: verify-changed-files with: # Indicates whether to fail if files have changed. # Type: boolean # Default: "false" fail-if-changed: '' # Message to display when files have changed and the # `fail-if-changed` input is set to `true`. # Type: string # Default: "Files have changed." 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: '' # 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
Max Kahnt

William Killerud
William Killerud

Minecraftschurli
Minecraftschurli

Stefan Hoth
Stefan Hoth

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

近期下载者

相关文件


收藏者