Updated README.md

This commit is contained in:
jackton1 2022-03-22 21:36:57 +00:00 committed by GitHub
parent 9dfb007996
commit 6de8a96658

View File

@ -68,9 +68,9 @@ Support this project with a :star:
<!-- AUTO-DOC-OUTPUT:START - Do not remove or modify this section --> <!-- AUTO-DOC-OUTPUT:START - Do not remove or modify this section -->
| OUTPUT | TYPE | DESCRIPTION | | OUTPUT | TYPE | DESCRIPTION |
|-----------------|--------|----------------------------------------------------------------------------------------------------------------------------------| |-----------------|--------|---------------------------------------------------------------------------------------------------------------|
| base\_ref\_branch | string | The target branch of a pull request<br>e.g `main` | | base\_ref\_branch | string | The target branch of a pull request<br>e.g `main` |
| current\_branch | string | Returns the value of the current branch<br>which is consistent regardless of event\_type e.g<br>`main`, `feature/test`, `v0.0.1`. | | current\_branch | string | Returns the value of the current branch<br>regardless of event\_type e.g `main`, `feature/test`, `v0.0.1`.<br> |
| default\_branch | string | | | default\_branch | string | |
| head\_ref\_branch | string | The source branch of a pull request<br>e.g `feature/test` | | head\_ref\_branch | string | The source branch of a pull request<br>e.g `feature/test` |
| is\_default | string | Returns `"true"` if the current branch is<br>the default else `"false"`. | | is\_default | string | Returns `"true"` if the current branch is<br>the default else `"false"`. |