-
Notifications
You must be signed in to change notification settings - Fork 51
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
3 changed files
with
62 additions
and
26 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -10,11 +10,59 @@ | |
## Inputs | ||
See [action.yaml](action.yaml). | ||
```yaml | ||
- name: Deploy | ||
uses: deployphp/action@v1 | ||
with: | ||
# Private key for connecting to remote hosts. To generate private key: | ||
# `ssh-keygen -o -t rsa -C '[email protected]'`. | ||
# Required. | ||
private-key: ${{ secrets.PRIVATE_KEY }} | ||
|
||
# The deployer task to run. For example: | ||
# `deploy all`. | ||
# Required. | ||
dep: deploy | ||
|
||
# Content of `~/.ssh/known_hosts` file. The public SSH keys for a | ||
# host may be obtained using the utility `ssh-keyscan`. | ||
# For example: `ssh-keyscan deployer.org`. | ||
# If known-hosts omitted, `StrictHostKeyChecking no` will be added to | ||
# `ssh_config`. | ||
# Optional. | ||
known-hosts: | | ||
... | ||
# The SSH configuration. Content of `~/.ssh/config` file. | ||
# Optional. | ||
ssh-config: | | ||
... | ||
# Deployer version to download from deployer.org. | ||
# First, the action will check for Deployer binary at those paths: | ||
# - `vendor/bin/dep` | ||
# - `deployer.phar` | ||
# If the binary not found, phar version will be downloaded from | ||
# deployer.org. | ||
# Optional. | ||
deployer-version: "7.0.0" | ||
|
||
# You can specify path to your local Deployer binary in the repo. | ||
# Optional. | ||
deployer-binary: "bin/dep" | ||
``` | ||
## Example | ||
```yaml | ||
name: deploy | ||
|
||
on: push | ||
|
||
# It is important to specify "concurrency" for the workflow, | ||
# to prevent concurrency between different deploys. | ||
concurrency: production_environment | ||
|
||
jobs: | ||
deploy: | ||
runs-on: ubuntu-latest | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -6,45 +6,31 @@ inputs: | |
|
||
private-key: | ||
required: true | ||
description: > | ||
Private key for connecting to remote hosts. To generate private key: | ||
`ssh-keygen -o -t rsa -C '[email protected]'`. | ||
description: The private key for connecting to remote hosts. | ||
|
||
dep: | ||
required: true | ||
description: > | ||
The deployer task to run. For example: | ||
`deploy all`. | ||
description: The command. | ||
|
||
known-hosts: | ||
required: false | ||
default: '' | ||
description: > | ||
Content of `~/.ssh/known_hosts` file. The public SSH keys for a | ||
host may be obtained using the utility `ssh-keyscan`. For example, | ||
`ssh-keyscan deployer.org`. | ||
If known-hosts omitted, `StrictHostKeyChecking no` will be added to | ||
`ssh_config`. | ||
description: Content of `~/.ssh/known_hosts` file. | ||
|
||
ssh-config: | ||
required: false | ||
default: '' | ||
description: > | ||
The SSH configuration. Content of `~/.ssh/config` file. | ||
description: The SSH configuration | ||
|
||
deployer-version: | ||
required: false | ||
default: '' | ||
description: > | ||
Deployer version to download from deployer.org. | ||
First, the action will check for Deployer binary at those paths: | ||
- `vendor/bin/dep` | ||
- `deployer.phar` | ||
description: Deployer version to download from deployer.org. | ||
|
||
If the binary not found, phar version will be downloaded from | ||
[deployer.org](https://deployer.org/download). | ||
deployer-binary: | ||
required: false | ||
default: '' | ||
description: Path to local Deployer binary. | ||
|
||
runs: | ||
using: 'node12' | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters