Updated README.md

tj-actions · Mar 22, 2022 · 9eb547a · 9eb547a
1 parent e81d539
commit 9eb547a
Showing 1 changed file with 23 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -65,6 +65,21 @@ Support this project with a :star:
 
 ## Outputs
 
+<!-- AUTO-DOC-OUTPUT:START - Do not remove or modify this section -->
+
+|     OUTPUT      |  TYPE  |                                                          DESCRIPTION                                                          |
+|-----------------|--------|-------------------------------------------------------------------------------------------------------------------------------|
+| base\_ref\_branch | string | The target branch of a<br>pull request e.g main                                                                               |
+| current\_branch  | string | Returns the value of the<br>current branch which is consistent<br>regardless of event\_type e.g main,<br>feature/test, v0.0.1. |
+| default\_branch  | string |                                                                                                                               |
+| head\_ref\_branch | string | The source branch of a<br>pull request e.g feature/test                                                                       |
+| is\_default      | string | Returns "true" if the current<br>branch is the default else<br>"false".                                                       |
+| is\_tag          | string | Returns "true" if the current<br>branch is a tag else<br>"false".                                                             |
+| ref\_branch      | string | The branch that triggered the<br>workflow run. e.g 1/merge, main<br>                                                          |
+| tag             | string | The tag that triggered the<br>workflow run. e.g v0.0.1, 0.0.1<br>                                                             |
+
+<!-- AUTO-DOC-OUTPUT:END -->
+
 |   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
 
+<!-- AUTO-DOC-INPUT:START - Do not remove or modify this section -->
+
+|      INPUT       |  TYPE  | REQUIRED | DEFAULT |                          DESCRIPTION                           |
+|------------------|--------|----------|---------|----------------------------------------------------------------|
+| strip\_tag\_prefix | string | false    |         | The tag prefix to strip<br>e.g v0.0.1 -> (strip v)<br>-> 0.0.1 |
+
+<!-- AUTO-DOC-INPUT:END -->
+
 | Input             |   type    |  default | Description             |
 |:-----------------:|:---------:|:--------:|:-----------------------:|
 | strip\_tag\_prefix  |  `string` |    `''`  | The tag prefix to strip <br> e.g `v0.0.1` -> `v` -> `0.0.1`  |