diff --git a/README.md b/README.md index 83506b41..eb8a7456 100644 --- a/README.md +++ b/README.md @@ -21,8 +21,8 @@ Get a branch or tag name without the `/ref/*` prefix. * [Features](#features) * [Usage](#usage) -* [Outputs](#outputs) * [Inputs](#inputs) +* [Outputs](#outputs) * [Events](#events) * [`push*`](#push) * [`pull_request*`](#pull_request) @@ -103,9 +103,23 @@ Support this project with a :star: - ## Outputs + + +| OUTPUT | TYPE | DESCRIPTION | +|---------------------------------------------------------------------------------|--------|----------------------------------------------------------------------------------| +| [base\_ref\_branch](#output_base_ref_branch) | string | The target branch of a
pull request or tag e.g
`main` | +| [current\_branch](#output_current_branch) | string | The current branch name regardless
of event\_type e.g `main`, `feature/test` | +| [default\_branch](#output_default_branch) | string | The default branch name e.g
`main` OR `master` | +| [head\_ref\_branch](#output_head_ref_branch) | string | The source branch of a
pull request e.g `feature/test` | +| [is\_default](#output_is_default) | string | Returns `"true"` if the current
branch is the default else
`"false"`. | +| [is\_tag](#output_is_tag) | string | Returns `"true"` if the current
branch is a tag else
`"false"`. | +| [ref\_branch](#output_ref_branch) | string | The branch that triggered the
workflow run. e.g `1/merge`, `main` | +| [tag](#output_tag) | string | The tag that triggered the
workflow run. e.g `v0.0.1`, `0.0.1` | + + + ## Events ### `push*`