mirror of
https://github.com/deployphp/action.git
synced 2024-11-23 12:29:03 +00:00
Update README.md
This commit is contained in:
parent
071ce25a35
commit
f3a105d45e
25
README.md
25
README.md
@ -1,18 +1,19 @@
|
|||||||
# GitHub Action for Deployer
|
# GitHub Action for Deployer
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
- name: Deploy
|
||||||
|
uses: deployer/deploy@v1
|
||||||
|
with:
|
||||||
|
private-key: ${{ secrets.PRIVATE_KEY }}
|
||||||
|
known-hosts: ${{ secrets.KNOWN_HOSTS }}
|
||||||
|
dep: deploy prod -v
|
||||||
|
```
|
||||||
|
|
||||||
## Inputs
|
## Inputs
|
||||||
|
|
||||||
### `private-key`
|
- `private-key` - Required. A private key to accessing servers.
|
||||||
|
- `known-hosts` - Optional. Host fingerprints. If omitted `StrictHostKeyChecking=no` will be used.
|
||||||
Required. A private key to accessing servers.
|
- `dep` - Required. Arguments to pass to Deployer command.
|
||||||
|
|
||||||
### `known-hosts`
|
|
||||||
|
|
||||||
Optional. Host fingerprints. If omitted `StrictHostKeyChecking=no` will be used.
|
|
||||||
|
|
||||||
### `dep`
|
|
||||||
|
|
||||||
Arguments to pass to Deployer command.
|
|
||||||
|
|
||||||
## Deployer version
|
## Deployer version
|
||||||
|
|
||||||
@ -36,7 +37,7 @@ deploy:
|
|||||||
with:
|
with:
|
||||||
php-version: 7.4
|
php-version: 7.4
|
||||||
- name: Deploy
|
- name: Deploy
|
||||||
uses: deployphp/action@v1
|
uses: deployer/deploy@v1
|
||||||
with:
|
with:
|
||||||
private-key: ${{ secrets.PRIVATE_KEY }}
|
private-key: ${{ secrets.PRIVATE_KEY }}
|
||||||
known-hosts: ${{ secrets.KNOWN_HOSTS }}
|
known-hosts: ${{ secrets.KNOWN_HOSTS }}
|
||||||
|
Loading…
Reference in New Issue
Block a user