Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improved description of inputs and outputs #20

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,29 @@ See [action.yml](action.yml)
format: ''
```

## Inputs

| Input | type | required | default | description |
|:-------------:|:-----------:|:-------------:|:----------------------:|:---------------------------------------------:|
| token | `string` | `true` | `${{ github.token }}` | Github token used to accessing the repository |
| format | `string` | `true` | `space-delimited` | Format of the steps output context.<br /> (Choices: 'space-delimited', 'csv', 'json') |



## Outputs

| Output | type | Description |
|:--------------------------------------------:|:-----------:|:----------------------------------------:|
| all | `string` | Array of all changed files. |
| added | `string` | Array of added files |
| modified | `string` | Array of modified files. |
| removed | `string` | Array of removed files. |
| renamed | `string` | Array of renamed files. |
| added_modified | `string` | Array of all added and modified files. |
| deleted <br />(For backwards-compatibility) | `string` | Array of deleted files. |



# Scenarios

- [Get all changed files as space-delimited](#get-all-changed-files-as-space-delimited)
Expand Down