From cef10ce0a670ca814854c5f2f28f6c2ab63528f3 Mon Sep 17 00:00:00 2001 From: Tonye Jack Date: Sun, 7 Feb 2021 20:19:06 -0500 Subject: [PATCH] Update README.md --- README.md | 30 +++++++++++------------------- 1 file changed, 11 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index 8d7c01d..38af3f3 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,17 @@ branch-names Get branch information without the `/ref/*` prefix +## Outputs + +| Output | type | Example | Description | +|:--------------------:|:-----------:|:---------------------------:|:-----------------------------------------------------------:| +| current_branch | `string` | `main` or `feature/test` | Always returns the branch that triggered the workflow run. | +| base_ref_branch | `string` | `main` | The target branch of a pull request | +| head_ref_branch | `string` | `feature/test` | The source branch of a pull request | +| ref_branch | `string` | `1/merge` OR `main` | The branch that triggered the workflow run | + + + ```yaml ... steps: @@ -66,25 +77,6 @@ on: ``` -## Inputs - -| Input | type | required | default | -|:-------------:|:-----------:|:-------------:|:---------------------:| -| token | `string` | `false` | `${{ github.token }}` | - - - - -## Outputs - -| Output | type | Example | Description | -|:--------------------:|:-----------:|:---------------------:|:------------------------------------------------:| -| current_branch | `string` | `main` | Always returns the branch that triggered the workflow run. | -| base_ref_branch | `string` | `main` | The target branch of a pull request | -| head_ref_branch | `string` | `feature/test` | The source branch of a pull request | -| ref_branch | `string` | `1/merge` OR `main` | The branch that triggered the workflow run | - - * Free software: [MIT license](LICENSE)