Update README.md

This commit is contained in:
Tonye Jack 2022-03-22 17:25:15 -04:00 committed by GitHub
parent af5fb3398b
commit 5225f98969
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -80,16 +80,6 @@ Support this project with a :star:
<!-- AUTO-DOC-OUTPUT:END --> <!-- AUTO-DOC-OUTPUT:END -->
| Output | type | Example | Description |
|:--------------------:|:------------:|:---------------------------:|:-----------------------------------------------------------------:|
| is\_default | `boolean` | `true` *OR* `false` | Detects wheter the workflow is running on a default branch |
| is\_tag | `boolean` | `true` *OR* `false` | Detects wheter the workflow is running on a tag branch |
| current\_branch | `string` | `main` <br> *OR* <br> `feature/test` <br> *OR* <br> `v0.0.1` | Always returns a valid branch name for a triggered workflow run. |
| base\_ref\_branch | `string` | `main` | The target branch of a pull request |
| head\_ref\_branch | `string` | `feature/test` | The source branch of a pull request |
| ref\_branch | `string` | `1/merge` *OR* `main` | The branch that triggered the workflow run |
| tag | `string` | `v0.0.1` *OR* `0.0.1` | The tag that triggered the workflow run |
## Inputs ## Inputs
<!-- AUTO-DOC-INPUT:START - Do not remove or modify this section --> <!-- AUTO-DOC-INPUT:START - Do not remove or modify this section -->
@ -100,10 +90,6 @@ Support this project with a :star:
<!-- AUTO-DOC-INPUT:END --> <!-- 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` |
## Events ## Events
* `push*` * `push*`