From 6f1f3207e07704c3e586bcf4d62605cdce54af78 Mon Sep 17 00:00:00 2001 From: Tonye Jack Date: Fri, 8 Jan 2021 13:53:31 -0500 Subject: [PATCH 1/3] Improved description of inputs and outputs --- README.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/README.md b/README.md index 3f4401bf..6e2089f1 100644 --- a/README.md +++ b/README.md @@ -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.
(Choices: 'space-delimited', 'csv', 'json') | + + + +## Outputs + +| Output | type | Description | +|:--------------------------------------:|:-----------:|:----------------------------------------:| +| all | `array` | Array of all changed files. | +| added | `array` | Array of added files | +| modified | `array` | Array of modified files. | +| removed | `array` | Array of removed files. | +| renamed | `array` | Array of renamed files. | +| added_modified | `array` | Array of all added and modified files. | +| deleted
(For backwards-compatibility) | `array` | Array of deleted files. | + + + # Scenarios - [Get all changed files as space-delimited](#get-all-changed-files-as-space-delimited) From 1c57051b56269c1b7317efe35b1a0515436515a1 Mon Sep 17 00:00:00 2001 From: Tonye Jack Date: Fri, 8 Jan 2021 15:23:14 -0500 Subject: [PATCH 2/3] Update README.md --- README.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 6e2089f1..d410a20b 100644 --- a/README.md +++ b/README.md @@ -33,15 +33,15 @@ See [action.yml](action.yml) ## Outputs -| Output | type | Description | -|:--------------------------------------:|:-----------:|:----------------------------------------:| -| all | `array` | Array of all changed files. | -| added | `array` | Array of added files | -| modified | `array` | Array of modified files. | -| removed | `array` | Array of removed files. | -| renamed | `array` | Array of renamed files. | -| added_modified | `array` | Array of all added and modified files. | -| deleted
(For backwards-compatibility) | `array` | Array of deleted files. | +| Output | type | Description | +|:--------------------------------------------:|:-----------:|:----------------------------------------:| +| all | `array` | Array of all changed files. | +| added | `array` | Array of added files | +| modified | `array` | Array of modified files. | +| removed | `array` | Array of removed files. | +| renamed | `array` | Array of renamed files. | +| added_modified | `array` | Array of all added and modified files. | +| deleted
(For backwards-compatibility) | `array` | Array of deleted files. | From b95f4c3e6d0878e6ad140df418ef145953c9be3d Mon Sep 17 00:00:00 2001 From: Tonye Jack Date: Sat, 18 Dec 2021 19:58:17 -0500 Subject: [PATCH 3/3] Update README.md --- README.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index d410a20b..02a04981 100644 --- a/README.md +++ b/README.md @@ -35,13 +35,13 @@ See [action.yml](action.yml) | Output | type | Description | |:--------------------------------------------:|:-----------:|:----------------------------------------:| -| all | `array` | Array of all changed files. | -| added | `array` | Array of added files | -| modified | `array` | Array of modified files. | -| removed | `array` | Array of removed files. | -| renamed | `array` | Array of renamed files. | -| added_modified | `array` | Array of all added and modified files. | -| deleted
(For backwards-compatibility) | `array` | Array of deleted files. | +| 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
(For backwards-compatibility) | `string` | Array of deleted files. |