Punctuation (#90)

This commit is contained in:
Josh Soref 2021-06-09 09:31:52 -04:00 committed by GitHub
parent 11eb1ff90c
commit a0682a8245
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -7,8 +7,8 @@ Retrieve all changed files relative to the default branch (`pull_request*` event
## Features ## Features
- List all files that have changed - List all files that have changed.
- Between the current pull request branch and the default branch - Between the current pull request branch and the default branch.
- Between the last commit and the current pushed change. - Between the last commit and the current pushed change.
- Restrict change detection to a subset of files. - Restrict change detection to a subset of files.
- Report on files that have at least one change. - Report on files that have at least one change.
@ -60,7 +60,7 @@ jobs:
|:---------:|:------------:| |:---------:|:------------:|
| A | Added | | A | Added |
| C | Copied | | C | Copied |
| M | Modified. | | M | Modified |
| D | Deleted | | D | Deleted |
| R | Renamed | | R | Renamed |
| T | Type changed | | T | Type changed |
@ -69,10 +69,10 @@ jobs:
| Output | type | example | description | | Output | type | example | description |
|:-------------------:|:------------:|:------------------------------:|:----------------------------------------:| |:--------------------:|:------------:|:----------------------------------:|:----------------------------------------:|
| any_changed | `string` | `true` OR `false` | Returns `true` when any of the filenames provided using the `files` input has changed | | any_changed | `string` | `true` OR `false` | Returns `true` when any of the filenames provided using the `files` input has changed |
| all_modified_files | `string` | `'new.txt path/to/file.png ...'` | Select all modified files <br /> i.e *a combination of all added, <br />copied and modified files (ACM).* | | all_modified_files | `string` | `'new.txt path/to/file.png ...'` | Select all modified files <br /> i.e. *a combination of all added, <br />copied and modified files (ACM).* |
| all_changed_files | `string` | `'new.txt path/to/file.png ...'` | Select all paths (*) <br /> i.e *a combination of all options below.* | | all_changed_files | `string` | `'new.txt path/to/file.png ...'` | Select all paths (*) <br /> i.e. *a combination of all options below.* |
| added_files | `string` | `'new.txt path/to/file.png ...'` | Select only files that are Added (A) | | added_files | `string` | `'new.txt path/to/file.png ...'` | Select only files that are Added (A) |
| copied_files | `string` | `'new.txt path/to/file.png ...'` | Select only files that are Copied (C) | | copied_files | `string` | `'new.txt path/to/file.png ...'` | Select only files that are Copied (C) |
| deleted_files | `string` | `'new.txt path/to/file.png ...'` | Select only files that are Deleted (D) | | deleted_files | `string` | `'new.txt path/to/file.png ...'` | Select only files that are Deleted (D) |
@ -86,12 +86,11 @@ jobs:
## Inputs ## Inputs
| Input | type | required | default | description | | Input | type | required | default | description |
|:-------------:|:-----------:|:-------------:|:----------------------------:|:-------------:| |:-------------:|:-----------:|:-------------:|:-----------------------------:|:-------------:|
| token | `string` | `false` | `${{ 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) <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) | | token | `string` | `false` | `${{ 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) <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) |
| separator | `string` | `true` | `' '` | Output string separator | | separator | `string` | `true` | `' '` | Output string separator |
| files | `string` OR `string[]` | `false` | | Restricted list <br> or string of specific <br> files or filename <br> to watch for changes | | files | `string` OR `string[]` | `false` | | Restricted list <br> or string of specific <br> files or filename <br> to watch for changes |
## Example ## Example
```yaml ```yaml