Skip to content

Commit dfd4e84

Browse files
author
Jose Diaz-Gonzalez
committed
docs: fix italics
1 parent 5ba42b1 commit dfd4e84

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,38 +8,38 @@ Please note that this action is compatible with `dokku >= 0.11.6`.
88

99
## Inputs
1010

11-
- `branch`: (__optional__) The branch to deploy when pushing to Dokku. Useful when a [custom deploy branch](http://dokku.viewdocs.io/dokku/deployment/methods/git/#changing-the-deploy-branch) is set on Dokku.
11+
- `branch`: (_optional_) The branch to deploy when pushing to Dokku. Useful when a [custom deploy branch](http://dokku.viewdocs.io/dokku/deployment/methods/git/#changing-the-deploy-branch) is set on Dokku.
1212
- default: `master`
1313
- example value: `main`
1414

15-
- `ci_branch_name`: (__optional__) The branch name that triggered the deploy. Automatically detected from `GITHUB_REF`.
15+
- `ci_branch_name`: (_optional_) The branch name that triggered the deploy. Automatically detected from `GITHUB_REF`.
1616
- example value: `develop`
1717

18-
- `ci_commit`: (__optional__) The commit sha that will be pushed. Automatically detected from `GITHUB_SHA`.
18+
- `ci_commit`: (_optional_) The commit sha that will be pushed. Automatically detected from `GITHUB_SHA`.
1919
- example value: `0aa00d8dd7c971c121e3d1e471d0a35e1daf8abe`
2020

21-
- `command`: (__optional__) The command to run for the action.
21+
- `command`: (_optional_) The command to run for the action.
2222
- default: deploy
2323
- valid values:
2424
- `deploy`
2525
- `review-apps:create`: Used to create a review app - via `dokku apps:clone` - based on the `appname` configured in the `git_remote_url`. If the review app already exists, this action will not recreate the app. In both cases, the current commit will be pushed to the review app.
2626
- `review-apps:destroy`: Destroys an existing review app.
2727

28-
- `git_push_flags`: (__optional__) A string containing a set of flags to set on push. This may be used to enable force pushes, or trigger verbose log output from git.
28+
- `git_push_flags`: (_optional_) A string containing a set of flags to set on push. This may be used to enable force pushes, or trigger verbose log output from git.
2929
- example value: `--force -vvv`
3030

31-
- `git_remote_url`: (**required**) The dokku app's git repository url **(in SSH format)**.
31+
- `git_remote_url`: (**required**) The dokku app's git repository url in SSH format.
3232
- required: true
3333
- example value: `ssh://dokku@dokku.myhost.ca:22/appname`
3434

35-
- `review_app_name`: (__optional__) The name of the review app to create or destroy. Computed as `review-$APPNAME-$BRANCH_NAME` if not specified, where:
35+
- `review_app_name`: (_optional_) The name of the review app to create or destroy. Computed as `review-$APPNAME-$BRANCH_NAME` if not specified, where:
3636
```text
3737
$APPNAME: The parsed app name from the `git_remote_url`
3838
$BRANCH_NAME: The inflected git branch name
3939
```
4040
- example value: `review-appname`
4141

42-
- `ssh_host_key`: (__optional__) The results of running `ssh-keyscan -t rsa $HOST`. The github-action will otherwise generate this on the fly via `ssh-keyscan`.
42+
- `ssh_host_key`: (_optional_) The results of running `ssh-keyscan -t rsa $HOST`. The github-action will otherwise generate this on the fly via `ssh-keyscan`.
4343
- example value:
4444
```text
4545
# dokku.com:22 SSH-2.0-OpenSSH_8.2p1 Ubuntu-4ubuntu0.1

0 commit comments

Comments
 (0)