Skip to content

Commit

Permalink
Updated README.md (#187)
Browse files Browse the repository at this point in the history
* Updated README.md

* Update action.yml

* Update README.md

Co-authored-by: jackton1 <jackton1@users.noreply.github.com>
  • Loading branch information
jackton1 and jackton1 committed Jul 26, 2022
1 parent 2466281 commit d920905
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 13 deletions.
27 changes: 17 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,19 +94,26 @@ Support this project with a :star:
## Inputs
| Input | type | required | default | description |
|:-------------:|:-----------:|:--------------:|:-----------------------------:|:--------------------------:|
| token | `string` | `true` | `${{ github.token }}` <br/> | [GITHUB\_TOKEN](https://docs.github.com/en/free-pro-team@latest/actions/reference/authentication-in-a-workflow#using-the-github_token-in-a-workflow) <br /> or a repo scoped <br /> [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 <br> using only <br> 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) <br> setting possible values <br> (true, false, input). |
| separator | `string` | `true` | `' '` | Output string separator |
<!-- AUTO-DOC-INPUT:START - Do not remove or modify this section -->
| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION |
|-----------|--------|----------|-----------|--------------------------------------------------------------------------|
| autocrlf | string | true | `"input"` | Modify the core.autocrlf setting possible<br>values (true, false, input) |
| files | string | true | | List of files to check<br>for changes. |
| separator | string | true | `" "` | Split character for array output<br> |
<!-- AUTO-DOC-INPUT:END -->
## 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 <br/> that changed <br/> during the workflow execution |
<!-- AUTO-DOC-OUTPUT:START - Do not remove or modify this section -->
| OUTPUT | TYPE | DESCRIPTION |
|---------------|--------|------------------------------------------------|
| changed\_files | string | List of changed files |
| files\_changed | string | Boolean indicating that files have<br>changed. |
<!-- AUTO-DOC-OUTPUT:END -->
* Free software: [MIT license](LICENSE)
Expand Down
6 changes: 3 additions & 3 deletions action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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: " "

Expand Down

0 comments on commit d920905

Please sign in to comment.