From 9eb547a602acc86e139366215cab728030db28a1 Mon Sep 17 00:00:00 2001 From: jackton1 Date: Tue, 22 Mar 2022 21:21:35 +0000 Subject: [PATCH] Updated README.md --- README.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/README.md b/README.md index e429ff1..61dd68e 100644 --- a/README.md +++ b/README.md @@ -65,6 +65,21 @@ Support this project with a :star: ## Outputs + + +| OUTPUT | TYPE | DESCRIPTION | +|-----------------|--------|-------------------------------------------------------------------------------------------------------------------------------| +| base\_ref\_branch | string | The target branch of a
pull request e.g main | +| current\_branch | string | Returns the value of the
current branch which is consistent
regardless of event\_type e.g main,
feature/test, v0.0.1. | +| default\_branch | string | | +| head\_ref\_branch | string | The source branch of a
pull request e.g feature/test | +| is\_default | string | Returns "true" if the current
branch is the default else
"false". | +| is\_tag | string | Returns "true" if the current
branch is a tag else
"false". | +| ref\_branch | string | The branch that triggered the
workflow run. e.g 1/merge, main
| +| tag | string | The tag that triggered the
workflow run. e.g v0.0.1, 0.0.1
| + + + | Output | type | Example | Description | |:--------------------:|:------------:|:---------------------------:|:-----------------------------------------------------------------:| | is\_default | `boolean` | `true` *OR* `false` | Detects wheter the workflow is running on a default branch | @@ -77,6 +92,14 @@ Support this project with a :star: ## Inputs + + +| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION | +|------------------|--------|----------|---------|----------------------------------------------------------------| +| strip\_tag\_prefix | string | false | | The tag prefix to strip
e.g v0.0.1 -> (strip v)
-> 0.0.1 | + + + | Input | type | default | Description | |:-----------------:|:---------:|:--------:|:-----------------------:| | strip\_tag\_prefix | `string` | `''` | The tag prefix to strip
e.g `v0.0.1` -> `v` -> `0.0.1` |