Skip to content

Commit e90c282

Browse files
author
Jose Diaz-Gonzalez
committed
docs: fix codeblocks
1 parent 8b77eb8 commit e90c282

File tree

1 file changed

+4
-7
lines changed

1 file changed

+4
-7
lines changed

README.md

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -11,36 +11,32 @@ Please note that this action is compatible with `dokku >= 0.11.6`.
1111
- `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`
14-
1514
- `ci_branch_name`: (_optional_) The branch name that triggered the deploy. Automatically detected from `GITHUB_REF`.
1615
- example value: `develop`
17-
1816
- `ci_commit`: (_optional_) The commit sha that will be pushed. Automatically detected from `GITHUB_SHA`.
1917
- example value: `0aa00d8dd7c971c121e3d1e471d0a35e1daf8abe`
20-
2118
- `command`: (_optional_) The command to run for the action.
2219
- default: deploy
2320
- valid values:
2421
- `deploy`
2522
- `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.
2623
- `review-apps:destroy`: Destroys an existing review app.
27-
2824
- `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.
2925
- example value: `--force -vvv`
30-
3126
- `git_remote_url`: (**required**) The dokku app's git repository url in SSH format.
3227
- required: true
3328
- example value: `ssh://dokku@dokku.myhost.ca:22/appname`
34-
3529
- `review_app_name`: (_optional_) The name of the review app to create or destroy. Computed as `review-$APPNAME-$BRANCH_NAME` if not specified, where:
30+
3631
```text
3732
$APPNAME: The parsed app name from the `git_remote_url`
3833
$BRANCH_NAME: The inflected git branch name
3934
```
40-
- example value: `review-appname`
4135

36+
- example value: `review-appname`
4237
- `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`.
4338
- example value:
39+
4440
```text
4541
# dokku.com:22 SSH-2.0-OpenSSH_8.2p1 Ubuntu-4ubuntu0.1
4642
dokku.com ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABgQCvS+lK38EEMdHGb...
@@ -49,6 +45,7 @@ Please note that this action is compatible with `dokku >= 0.11.6`.
4945
- `ssh_private_key`: (**required**) A private ssh key that has push access to the Dokku instance.
5046
- tip: It is recommended to use [Encrypted Secrets](https://docs.github.com/en/free-pro-team@latest/actions/reference/encrypted-secrets) to store sensitive information such as SSH Keys.
5147
- example value:
48+
5249
```text
5350
-----BEGIN OPENSSH PRIVATE KEY-----
5451
MIIEogIBAAKCAQEAjLdCs9kQkimyfOSa8IfXf4gmexWWv6o/IcjmfC6YD9LEC4He

0 commit comments

Comments
 (0)