From d9209057de3f220da6ee83ce77aa50c0bb7d0450 Mon Sep 17 00:00:00 2001 From: Tonye Jack Date: Mon, 25 Jul 2022 21:43:50 -0400 Subject: [PATCH] Updated README.md (#187) * Updated README.md * Update action.yml * Update README.md Co-authored-by: jackton1 --- README.md | 27 +++++++++++++++++---------- action.yml | 6 +++--- 2 files changed, 20 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 2c14331..42e0b8e 100644 --- a/README.md +++ b/README.md @@ -94,19 +94,26 @@ Support this project with a :star: ## Inputs -| Input | type | required | default | description | -|:-------------:|:-----------:|:--------------:|:-----------------------------:|:--------------------------:| -| token | `string` | `true` | `${{ github.token }}`
| [GITHUB\_TOKEN](https://docs.github.com/en/free-pro-team@latest/actions/reference/authentication-in-a-workflow#using-the-github_token-in-a-workflow)
or a repo scoped
[Personal Access Token](https://docs.github.com/en/free-pro-team@latest/github/authenticating-to-github/creating-a-personal-access-token) | -| files | `string[]` OR `string` | `true` | | Check for uncommited changes
using only
these list of file(s) | -| autocrlf | `string` | `true` | `input` | Modify the [core.autocrlf](https://git-scm.com/book/en/v2/Customizing-Git-Git-Configuration#_core_autocrlf)
setting possible values
(true, false, input). | -| separator | `string` | `true` | `' '` | Output string separator | + + +| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION | +|-----------|--------|----------|-----------|--------------------------------------------------------------------------| +| autocrlf | string | true | `"input"` | Modify the core.autocrlf setting possible
values (true, false, input) | +| files | string | true | | List of files to check
for changes. | +| separator | string | true | `" "` | Split character for array output
| + + ## Outputs -| Input | type | example | description | -|:-------------:|:-----------:|:-------------:|:--------------------------:| -| files\_changed | `string` | `true` OR `false` | Indicates that there are outstanding changes | -| changed\_files | `string` | `example.txt ...` | List of files
that changed
during the workflow execution | + + +| OUTPUT | TYPE | DESCRIPTION | +|---------------|--------|------------------------------------------------| +| changed\_files | string | List of changed files | +| files\_changed | string | Boolean indicating that files have
changed. | + + * Free software: [MIT license](LICENSE) diff --git a/action.yml b/action.yml index c2b75ec..192788e 100644 --- a/action.yml +++ b/action.yml @@ -3,14 +3,14 @@ description: Find files that were modified during workflow execution. author: jackton1 inputs: files: - description: List of files to check for changes. + description: 'File/Directory names to check for uncommited changes.' required: true autocrlf: - description: Modify the core.autocrlf setting possible values (true, false, input) + description: 'Modify the [core.autocrlf](https://git-scm.com/book/en/v2/Customizing-Git-Git-Configuration#_core_autocrlf).' default: 'input' required: true separator: - description: 'Split character for array output' + description: 'Output string separator.' required: true default: " "