Skip to content

Commit 43f1d99

Browse files
authored
Updated README.md
1 parent d2fdfdc commit 43f1d99

File tree

1 file changed

+16
-2
lines changed

1 file changed

+16
-2
lines changed

README.md

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,8 @@ Get a branch or tag name without the `/ref/*` prefix.
2121

2222
* [Features](#features)
2323
* [Usage](#usage)
24-
* [Outputs](#outputs)
2524
* [Inputs](#inputs)
25+
* [Outputs](#outputs)
2626
* [Events](#events)
2727
* [`push*`](#push)
2828
* [`pull_request*`](#pull_request)
@@ -103,9 +103,23 @@ Support this project with a :star:
103103

104104
<!-- AUTO-DOC-INPUT:END -->
105105

106-
107106
## Outputs
108107

108+
<!-- AUTO-DOC-OUTPUT:START - Do not remove or modify this section -->
109+
110+
| OUTPUT | TYPE | DESCRIPTION |
111+
|---------------------------------------------------------------------------------|--------|----------------------------------------------------------------------------------|
112+
| <a name="output_base_ref_branch"></a>[base\_ref\_branch](#output_base_ref_branch) | string | The target branch of a <br>pull request or tag e.g <br>`main` |
113+
| <a name="output_current_branch"></a>[current\_branch](#output_current_branch) | string | The current branch name regardless <br>of event\_type e.g `main`, `feature/test` |
114+
| <a name="output_default_branch"></a>[default\_branch](#output_default_branch) | string | The default branch name e.g <br>`main` OR `master` |
115+
| <a name="output_head_ref_branch"></a>[head\_ref\_branch](#output_head_ref_branch) | string | The source branch of a <br>pull request e.g `feature/test` |
116+
| <a name="output_is_default"></a>[is\_default](#output_is_default) | string | Returns `"true"` if the current <br>branch is the default else <br>`"false"`. |
117+
| <a name="output_is_tag"></a>[is\_tag](#output_is_tag) | string | Returns `"true"` if the current <br>branch is a tag else <br>`"false"`. |
118+
| <a name="output_ref_branch"></a>[ref\_branch](#output_ref_branch) | string | The branch that triggered the <br>workflow run. e.g `1/merge`, `main` |
119+
| <a name="output_tag"></a>[tag](#output_tag) | string | The tag that triggered the <br>workflow run. e.g `v0.0.1`, `0.0.1` |
120+
121+
<!-- AUTO-DOC-OUTPUT:END -->
122+
109123
## Events
110124

111125
### `push*`

0 commit comments

Comments
 (0)