From 47f2c87555570cd59e44aa8eb735b0ccb27cc86f Mon Sep 17 00:00:00 2001 From: jackton1 Date: Sat, 2 Dec 2023 11:31:37 +0000 Subject: [PATCH] Updated README.md --- README.md | 43 +++++++++++++++++++++++++++++++++++-------- 1 file changed, 35 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 2435e57..327f069 100644 --- a/README.md +++ b/README.md @@ -117,14 +117,41 @@ Support this project with a :star: -| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION | -|-------------------------------------------------------------------------------------------------|--------|----------|-------------------------|-------------------------------------------------------------------------------------------------------| -| [fail-if-changed](#input_fail-if-changed) | string | false | `"false"` | Indicates whether to fail if
files have changed. | -| [fail-message](#input_fail-message) | string | false | `"Files have changed."` | Message to display when files
have changed and the `fail-if-changed`
input is set to `true`. | -| [files](#input_files) | string | false | | File/Directory names to check for
uncommited changes. | -| [files-separator](#input_files-separator) | string | false | `"\n"` | Separator used to split the
`files` input | -| [match-gitignore-files](#input_match-gitignore-files) | string | true | `"false"` | Indicates whether to match files
in `.gitignore` | -| [separator](#input_separator) | string | false | `" "` | Output string separator. | +```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: '' + +```