Skip to content

Commit

Permalink
docs: fix codeblocks
Browse files Browse the repository at this point in the history
  • Loading branch information
Jose Diaz-Gonzalez committed Dec 4, 2020
1 parent 8b77eb8 commit e90c282
Showing 1 changed file with 4 additions and 7 deletions.
11 changes: 4 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,36 +11,32 @@ Please note that this action is compatible with `dokku >= 0.11.6`.
- `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.
- default: `master`
- example value: `main`

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

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

- `command`: (_optional_) The command to run for the action.
- default: deploy
- valid values:
- `deploy`
- `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.
- `review-apps:destroy`: Destroys an existing review app.

- `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.
- example value: `--force -vvv`

- `git_remote_url`: (**required**) The dokku app's git repository url in SSH format.
- required: true
- example value: `ssh://[email protected]:22/appname`

- `review_app_name`: (_optional_) The name of the review app to create or destroy. Computed as `review-$APPNAME-$BRANCH_NAME` if not specified, where:

```text
$APPNAME: The parsed app name from the `git_remote_url`
$BRANCH_NAME: The inflected git branch name
```
- example value: `review-appname`

- example value: `review-appname`
- `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`.
- example value:

```text
# dokku.com:22 SSH-2.0-OpenSSH_8.2p1 Ubuntu-4ubuntu0.1
dokku.com ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABgQCvS+lK38EEMdHGb...
Expand All @@ -49,6 +45,7 @@ Please note that this action is compatible with `dokku >= 0.11.6`.
- `ssh_private_key`: (**required**) A private ssh key that has push access to the Dokku instance.
- 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.
- example value:
```text
-----BEGIN OPENSSH PRIVATE KEY-----
MIIEogIBAAKCAQEAjLdCs9kQkimyfOSa8IfXf4gmexWWv6o/IcjmfC6YD9LEC4He
Expand Down

0 comments on commit e90c282

Please sign in to comment.