Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Updated README.md #169

Merged
merged 1 commit into from
Aug 27, 2022
Merged

Updated README.md #169

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
20 changes: 10 additions & 10 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,16 +67,16 @@ Support this project with a :star:

<!-- AUTO-DOC-OUTPUT:START - Do not remove or modify this section -->

| OUTPUT | TYPE | DESCRIPTION |
|-----------------|--------|-------------------------------------------------------------------------------------------|
| base\_ref\_branch | string | The target branch of a pull request<br>e.g `main` |
| current\_branch | string | The current branch name regardless of event\_type<br>e.g `main`, `feature/test`, `v0.0.1`. |
| default\_branch | string | The default branch name e.g `main` OR<br>`master` |
| 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\_tag | string | Returns `"true"` if the current branch is<br>a tag else `"false"`. |
| ref\_branch | string | The branch that triggered the workflow run.<br>e.g `1/merge`, `main` |
| tag | string | The tag that triggered the workflow run.<br>e.g `v0.0.1`, `0.0.1` |
| OUTPUT | TYPE | DESCRIPTION |
|-----------------|--------|-------------------------------------------------------------------------------------|
| base\_ref\_branch | string | The target branch of a pull request<br>or the source branch for a tag<br>e.g `main` |

Check warning

Code scanning / Markdownlint (reported by Codacy)

Element: br

Element: br

Check warning

Code scanning / Markdownlint (reported by Codacy)

Expected: 80; Actual: 116

Expected: 80; Actual: 116
| current\_branch | string | The current branch name regardless of event\_type<br>e.g `main`, `feature/test` |

Check warning

Code scanning / Markdownlint (reported by Codacy)

Expected: 80; Actual: 116

Expected: 80; Actual: 116

Check warning

Code scanning / Markdownlint (reported by Codacy)

Element: br

Element: br
| default\_branch | string | The default branch name e.g `main` OR<br>`master` |
| 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\_tag | string | Returns `"true"` if the current branch is<br>a tag else `"false"`. |
| ref\_branch | string | The branch that triggered the workflow run.<br>e.g `1/merge`, `main` |
| tag | string | The tag that triggered the workflow run.<br>e.g `v0.0.1`, `0.0.1` |

<!-- AUTO-DOC-OUTPUT:END -->

Expand Down