|
1 | 1 | # GitHub Action for Deployer |
2 | 2 |
|
3 | 3 | ```yaml |
4 | | - - name: Deploy |
5 | | - uses: deployphp/action@v1 |
6 | | - with: |
7 | | - dep: deploy |
8 | | - private-key: ${{ secrets.PRIVATE_KEY }} |
| 4 | +- name: Deploy |
| 5 | + uses: deployphp/action@v1 |
| 6 | + with: |
| 7 | + dep: deploy |
| 8 | + private-key: ${{ secrets.PRIVATE_KEY }} |
9 | 9 | ``` |
10 | 10 |
|
11 | 11 | ## Inputs |
12 | 12 |
|
13 | 13 | ```yaml |
14 | | - - name: Deploy |
15 | | - uses: deployphp/action@v1 |
16 | | - with: |
17 | | - # The deployer task to run. For example: |
18 | | - # `deploy all`. |
19 | | - # Required. |
20 | | - dep: deploy |
21 | | - |
22 | | - # The path to the PHP binary to use. |
23 | | - # Optional. |
24 | | - php-binary: "php" |
25 | | - |
26 | | - # Specifies a sub directory within the repository to deploy |
27 | | - # Optional |
28 | | - sub-directory: "..." |
29 | | - |
30 | | - # Config options for the Deployer. Same as the `-o` flag in the CLI. |
31 | | - # Optional. |
32 | | - options: |
33 | | - keep_releases: 7 |
34 | | - |
35 | | - # Private key for connecting to remote hosts. To generate private key: |
36 | | - # `ssh-keygen -o -t rsa -C 'action@deployer.org'`. |
37 | | - # Optional. |
38 | | - private-key: ${{ secrets.PRIVATE_KEY }} |
39 | | - |
40 | | - # Content of `~/.ssh/known_hosts` file. The public SSH keys for a |
41 | | - # host may be obtained using the utility `ssh-keyscan`. |
42 | | - # For example: `ssh-keyscan deployer.org`. |
43 | | - # If known-hosts omitted, `StrictHostKeyChecking no` will be added to |
44 | | - # `ssh_config`. |
45 | | - # Optional. |
46 | | - known-hosts: | |
47 | | - ... |
48 | | -
|
49 | | - # The SSH configuration. Content of `~/.ssh/config` file. |
50 | | - # Optional. |
51 | | - ssh-config: | |
52 | | - ... |
53 | | - |
54 | | - # Option to skip over the SSH setup/configuration. |
55 | | - # Self-hosted runners don't need the SSH configuration or the SSH agent |
56 | | - # to be started. |
57 | | - # Optional. |
58 | | - skip-ssh-setup: false |
59 | | - |
60 | | - # Deployer version to download from deployer.org. |
61 | | - # First, the action will check for Deployer binary at those paths: |
62 | | - # - `vendor/bin/deployer.phar` |
63 | | - # - `vendor/bin/dep` |
64 | | - # - `deployer.phar` |
65 | | - # If the binary not found, phar version will be downloaded from |
66 | | - # deployer.org. |
67 | | - # Optional. |
68 | | - deployer-version: "7.0.0" |
69 | | - |
70 | | - # You can specify path to your local Deployer binary in the repo. |
71 | | - # Optional. |
72 | | - deployer-binary: "bin/dep" |
73 | | - |
74 | | - # You can choose to disable ANSI output. |
75 | | - # Optional. Defaults to true. |
76 | | - ansi: false |
77 | | - |
78 | | - # You can specify the output verbosity level. |
79 | | - # Optional. Defaults to -v. |
80 | | - verbosity: -vvv |
| 14 | +- name: Deploy |
| 15 | + uses: deployphp/action@v1 |
| 16 | + with: |
| 17 | + # The deployer task to run. For example: |
| 18 | + # `deploy all`. |
| 19 | + # Required. |
| 20 | + dep: deploy |
| 21 | + |
| 22 | + # The path to the PHP binary to use. |
| 23 | + # Optional. |
| 24 | + php-binary: 'php' |
| 25 | + |
| 26 | + # Specifies a sub directory within the repository to deploy |
| 27 | + # Optional |
| 28 | + sub-directory: '...' |
| 29 | + |
| 30 | + # Config options for the Deployer. Same as the `-o` flag in the CLI. |
| 31 | + # Optional. |
| 32 | + options: |
| 33 | + keep_releases: 7 |
| 34 | + |
| 35 | + # Private key for connecting to remote hosts. To generate private key: |
| 36 | + # `ssh-keygen -o -t rsa -C 'action@deployer.org'`. |
| 37 | + # Optional. |
| 38 | + private-key: ${{ secrets.PRIVATE_KEY }} |
| 39 | + |
| 40 | + # Content of `~/.ssh/known_hosts` file. The public SSH keys for a |
| 41 | + # host may be obtained using the utility `ssh-keyscan`. |
| 42 | + # For example: `ssh-keyscan deployer.org`. |
| 43 | + # If known-hosts omitted, `StrictHostKeyChecking no` will be added to |
| 44 | + # `ssh_config`. |
| 45 | + # Optional. |
| 46 | + known-hosts: | |
| 47 | + ... |
| 48 | +
|
| 49 | + # The SSH configuration. Content of `~/.ssh/config` file. |
| 50 | + # Optional. |
| 51 | + ssh-config: | |
| 52 | + ... |
| 53 | +
|
| 54 | + # Option to skip over the SSH setup/configuration. |
| 55 | + # Self-hosted runners don't need the SSH configuration or the SSH agent |
| 56 | + # to be started. |
| 57 | + # Optional. |
| 58 | + skip-ssh-setup: false |
| 59 | + |
| 60 | + # Deployer version to download from deployer.org. |
| 61 | + # First, the action will check for Deployer binary at those paths: |
| 62 | + # - `vendor/bin/deployer.phar` |
| 63 | + # - `vendor/bin/dep` |
| 64 | + # - `deployer.phar` |
| 65 | + # If the binary not found, phar version will be downloaded from |
| 66 | + # deployer.org. |
| 67 | + # Optional. |
| 68 | + deployer-version: '7.0.0' |
| 69 | + |
| 70 | + # You can specify path to your local Deployer binary in the repo. |
| 71 | + # Optional. |
| 72 | + deployer-binary: 'bin/dep' |
| 73 | + |
| 74 | + # You can choose to disable ANSI output. |
| 75 | + # Optional. Defaults to true. |
| 76 | + ansi: false |
| 77 | + |
| 78 | + # You can specify the output verbosity level. |
| 79 | + # Optional. Defaults to -v. |
| 80 | + verbosity: -vvv |
81 | 81 | ``` |
82 | 82 |
|
83 | 83 | ## Example |
|
0 commit comments