You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+4-7Lines changed: 4 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,36 +11,32 @@ Please note that this action is compatible with `dokku >= 0.11.6`.
11
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.
12
12
- default: `master`
13
13
- example value: `main`
14
-
15
14
-`ci_branch_name`: (_optional_) The branch name that triggered the deploy. Automatically detected from `GITHUB_REF`.
16
15
- example value: `develop`
17
-
18
16
-`ci_commit`: (_optional_) The commit sha that will be pushed. Automatically detected from `GITHUB_SHA`.
19
17
- example value: `0aa00d8dd7c971c121e3d1e471d0a35e1daf8abe`
20
-
21
18
-`command`: (_optional_) The command to run for the action.
22
19
- default: deploy
23
20
- valid values:
24
21
-`deploy`
25
22
-`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.
26
23
-`review-apps:destroy`: Destroys an existing review app.
27
-
28
24
-`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.
29
25
- example value: `--force -vvv`
30
-
31
26
-`git_remote_url`: (**required**) The dokku app's git repository url in SSH format.
32
27
- required: true
33
28
- example value: `ssh://dokku@dokku.myhost.ca:22/appname`
34
-
35
29
-`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
+
36
31
```text
37
32
$APPNAME: The parsed app name from the `git_remote_url`
38
33
$BRANCH_NAME: The inflected git branch name
39
34
```
40
-
- example value: `review-appname`
41
35
36
+
- example value: `review-appname`
42
37
-`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`.
@@ -49,6 +45,7 @@ Please note that this action is compatible with `dokku >= 0.11.6`.
49
45
- `ssh_private_key`: (**required**) A private ssh key that has push access to the Dokku instance.
50
46
- 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.
0 commit comments