From c3105e7432fcfa3f4495a69de597d50d4222a19c Mon Sep 17 00:00:00 2001 From: Tonye Jack Date: Sat, 24 Apr 2021 04:49:18 -0400 Subject: [PATCH] Update README.md --- README.md | 75 ++++++++++++++++++++++++++++--------------------------- 1 file changed, 38 insertions(+), 37 deletions(-) diff --git a/README.md b/README.md index a6240d75..774b3227 100644 --- a/README.md +++ b/README.md @@ -8,6 +8,44 @@ Get all modified files relative to the default branch or preceding commit. ## Usage +## Outputs + +Using the default separator. + +| Acronym | Meaning | +|:---------:|:------------:| +| A | Added | +| C | Copied | +| M | Modified. | +| D | Deleted | +| R | Renamed | +| T | Type changed | +| U | Unmerged | +| X | Unknown | + + +| Output | type | example | description | +|:-------------------:|:------------:|:------------------------------:|:----------------------------------------:| +| all_modified_files | `string` | 'new.txt other.png ...' | Select all modified files
*i.e a combination of all added,
copied and modified files (ACM).* | +| all_changed_files | `string` | 'new.txt other.png ...' | Select all paths (*)
*i.e a combination of all options below.* | +| added_files | `string` | 'new.txt other.png ...' | Select only files that are Added (A) | +| copied_files | `string` | 'new.txt other.png ...' | Select only files that are Copied (C) | +| deleted_files | `string` | 'new.txt other.png ...' | Select only files that are Deleted (D) | +| modified_files | `string` | 'new.txt other.png ...' | Select only files that are Modified (M) | +| renamed_files | `string` | 'new.txt other.png ...' | Select only files that are Renamed (R) | +| changed_files | `string` | 'new.txt other.png ...' | Select only files that have their type changed (T) | +| unmerged_files | `string` | 'new.txt other.png ...' | Select only files that are Unmerged (U) | +| unknown_files | `string` | 'new.txt other.png ...' | Select only files that are Unknown (X) | + + +## Inputs + +| Input | type | required | default | description | +|:-------------:|:-----------:|:-------------:|:----------------------------:|:-------------:| +| separator | `string` | `true` | `' '` | Separator to return outputs | + + + ### Push event ```yaml @@ -110,43 +148,6 @@ jobs: ``` -## Inputs - -| Input | type | required | default | description | -|:-------------:|:-----------:|:-------------:|:----------------------------:|:-------------:| -| separator | `string` | `true` | `' '` | Separator to return outputs | - - - -## Outputs - -Using the default separator. - -| Acronym | Meaning | -|:---------:|:------------:| -| A | Added | -| C | Copied | -| M | Modified. | -| D | Deleted | -| R | Renamed | -| T | Type changed | -| U | Unmerged | -| X | Unknown | - - -| Output | type | example | description | -|:-------------------:|:------------:|:------------------------------:|:----------------------------------------:| -| all_modified_files | `string` | 'new.txt other.png ...' | Select all modified files
*i.e a combination of all added,
copied and modified files (ACM).* | -| all_changed_files | `string` | 'new.txt other.png ...' | Select all paths (*)
*i.e a combination of all options below.* | -| added_files | `string` | 'new.txt other.png ...' | Select only files that are Added (A) | -| copied_files | `string` | 'new.txt other.png ...' | Select only files that are Copied (C) | -| deleted_files | `string` | 'new.txt other.png ...' | Select only files that are Deleted (D) | -| modified_files | `string` | 'new.txt other.png ...' | Select only files that are Modified (M) | -| renamed_files | `string` | 'new.txt other.png ...' | Select only files that are Renamed (R) | -| changed_files | `string` | 'new.txt other.png ...' | Select only files that have their type changed (T) | -| unmerged_files | `string` | 'new.txt other.png ...' | Select only files that are Unmerged (U) | -| unknown_files | `string` | 'new.txt other.png ...' | Select only files that are Unknown (X) | - ## Example