Skip to content

Commit 4158862

Browse files
SamKirklandSamKirkland
committed
v3.1.2
node v16
1 parent 559ddbb commit 4158862

File tree

2 files changed

+31
-31
lines changed

2 files changed

+31
-31
lines changed

‎README.md

Lines changed: 29 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ jobs:
2323
with:
2424
fetch-depth: 2
2525
- name: FTP-Deploy-Action
26-
uses: SamKirkland/[email protected].1
26+
uses: SamKirkland/[email protected].2
2727
with:
2828
ftp-server: ftp://ftp.samkirkland.com/
2929
ftp-username: myFtpUserName
@@ -55,33 +55,33 @@ Keys can be added directly to your .yml config file or referenced from your proj
5555
To add a `secret` go to the `Settings` tab in your project then select `Secrets`.
5656
I recommend you store your `ftp-password` as a secret.
5757

58-
| Key Name | Required? | Example | Default | Description |
59-
|----------------|-----------|-----------------------------------------------|---------|----------------------------------------------------------|
60-
| `ftp-server` | Yes | ftp://ftp.samkirkland.com/destinationPath/ | | Deployment destination server & path. Formatted as `protocol://domain.com:port/destinationPath/` protocol can be `ftp`, `ftps`, or `sftp`. Port is optional, when not specified it will default to 21 when using ftp, 22 when using sftp, and 990 when using ftps |
61-
| `ftp-username` | Yes | [email protected] | | FTP account username |
62-
| `ftp-password` | Yes | CrazyUniquePassword&%123 | | FTP account password |
63-
| `local-dir` | No | deploy/ | ./ | Which local folder to deploy, path should be relative to the root and should include trailing slash. `./` is the root of the project |
64-
| `git-ftp-args` | No | See `git-ftp-args` section below | | Custom git-ftp arguments, this field is passed through directly into the git-ftp script |
65-
| `known-hosts` | No | hostname ssh-rsa AAAAB3NzaC1y ... | | The desired contents of your .ssh/known_hosts file. See [known hosts setup](#known-hosts-setup) |
58+
| Key Name | Required? | Example | Default | Description |
59+
|----------------|-----------|--------------------------------------------|---------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
60+
| `ftp-server` | Yes | ftp://ftp.samkirkland.com/destinationPath/ | | Deployment destination server & path. Formatted as `protocol://domain.com:port/destinationPath/` protocol can be `ftp`, `ftps`, or `sftp`. Port is optional, when not specified it will default to 21 when using ftp, 22 when using sftp, and 990 when using ftps |
61+
| `ftp-username` | Yes | [email protected] | | FTP account username |
62+
| `ftp-password` | Yes | CrazyUniquePassword&%123 | | FTP account password |
63+
| `local-dir` | No | deploy/ | ./ | Which local folder to deploy, path should be relative to the root and should include trailing slash. `./` is the root of the project |
64+
| `git-ftp-args` | No | See `git-ftp-args` section below | | Custom git-ftp arguments, this field is passed through directly into the git-ftp script |
65+
| `known-hosts` | No | hostname ssh-rsa AAAAB3NzaC1y ... | | The desired contents of your .ssh/known_hosts file. See [known hosts setup](#known-hosts-setup) |
6666

6767
#### Advanced options using `git-ftp-args`
6868
Custom arguments, this field is passed through directly into the git-ftp script. See [git-ftp's manual](https://github.com/git-ftp/git-ftp/blob/master/man/git-ftp.1.md) for all options.
6969
You can use as many arguments as you want, seperate them with a space
7070

7171
Below is an incomplete list of commonly used args:
7272

73-
| Argument | Description |
74-
|------------------------|------------------------------------------------------------------------------------------------------|
75-
| `--dry-run` | Does not upload or delete anything, but tries to get the .git-ftp.log file from remote host |
76-
| `--silent` | Be silent |
77-
| `--all` | Transfer all files, even seemingly the same as the target site (default is differences only). Note: Only files committed to github are uploaded, if you'd like to upload files generated during the action run see `.git-ftp-include` |
78-
| `--lock` | Locks remote files from being modified while a deployment is running |
79-
| `--remote-root` | Specifies the remote root directory to deploy to. The remote path in the URL is ignored |
80-
| `--key` | SSH private key file name for SFTP |
81-
| `--branch` | Push a specific branch. I recommend [creating a yaml action for each branch instead](https://github.com/SamKirkland/FTP-Deploy-Action/issues/37#issuecomment-579819486) |
82-
| `--pubkey` | SSH public key file name. Used with `--key` option |
83-
| `--insecure` | Don't verify server's certificate |
84-
| `--cacert <file>` | Use as CA certificate store. Useful when a server has a self-signed certificate |
73+
| Argument | Description |
74+
|-------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
75+
| `--dry-run` | Does not upload or delete anything, but tries to get the .git-ftp.log file from remote host |
76+
| `--silent` | Be silent |
77+
| `--all` | Transfer all files, even seemingly the same as the target site (default is differences only). Note: Only files committed to github are uploaded, if you'd like to upload files generated during the action run see `.git-ftp-include` |
78+
| `--lock` | Locks remote files from being modified while a deployment is running |
79+
| `--remote-root` | Specifies the remote root directory to deploy to. The remote path in the URL is ignored |
80+
| `--key` | SSH private key file name for SFTP |
81+
| `--branch` | Push a specific branch. I recommend [creating a yaml action for each branch instead](https://github.com/SamKirkland/FTP-Deploy-Action/issues/37#issuecomment-579819486) |
82+
| `--pubkey` | SSH public key file name. Used with `--key` option |
83+
| `--insecure` | Don't verify server's certificate |
84+
| `--cacert <file>` | Use as CA certificate store. Useful when a server has a self-signed certificate |
8585

8686
### Ignore specific files when deploying
8787
Add patterns to `.git-ftp-ignore` and all matching file names will be ignored. The patterns are interpreted as shell glob patterns.
@@ -183,7 +183,7 @@ jobs:
183183
with:
184184
fetch-depth: 2
185185
- name: FTP-Deploy-Action
186-
uses: SamKirkland/[email protected].1
186+
uses: SamKirkland/[email protected].2
187187
with:
188188
ftp-server: ftp://ftp.samkirkland.com/
189189
ftp-username: myFtpUserName
@@ -212,7 +212,7 @@ jobs:
212212
fetch-depth: 2
213213
214214
- name: FTP-Deploy-Action
215-
uses: SamKirkland/[email protected].1
215+
uses: SamKirkland/[email protected].2
216216
with:
217217
ftp-server: ftps://ftp.samkirkland.com:21/
218218
ftp-username: myFTPSUsername
@@ -259,7 +259,7 @@ jobs:
259259
fetch-depth: 2
260260
261261
- name: FTP-Deploy-Action
262-
uses: SamKirkland/[email protected].1
262+
uses: SamKirkland/[email protected].2
263263
with:
264264
ftp-server: sftp://ftp.samkirkland.com:7280/
265265
ftp-username: mySFTPUsername
@@ -284,10 +284,10 @@ jobs:
284284
with:
285285
fetch-depth: 2
286286
287-
- name: Use Node.js 12.x
288-
uses: actions/setup-node@v1
287+
- name: Use Node.js 16
288+
uses: actions/setup-node@v2
289289
with:
290-
node-version: '12.x'
290+
node-version: '16'
291291
292292
- name: Build Project
293293
run: |
@@ -298,7 +298,7 @@ jobs:
298298
run: ls
299299
300300
- name: FTP-Deploy-Action
301-
uses: SamKirkland/[email protected].1
301+
uses: SamKirkland/[email protected].2
302302
with:
303303
ftp-server: ftp://ftp.samkirkland.com/
304304
ftp-username: myFTPUsername
@@ -321,7 +321,7 @@ jobs:
321321
fetch-depth: 2
322322
323323
- name: FTP-Deploy-Action
324-
uses: SamKirkland/[email protected].1
324+
uses: SamKirkland/[email protected].2
325325
with:
326326
ftp-server: ftp://ftp.samkirkland.com/
327327
ftp-username: myFTPUsername

‎package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
{
22
"name": "typescript-action",
3-
"version": "1.0.0",
3+
"version": "3.1.2",
44
"private": true,
55
"description": "TypeScript template action",
66
"main": "dist/main.js",
77
"engines": {
8-
"node": ">=12.0.0"
8+
"node": ">=16.0.0"
99
},
1010
"scripts": {
1111
"build": "ncc build src/main.ts -o dist --watch",

0 commit comments

Comments
 (0)