Skip to content

Commit 59992de

Browse files
SamKirklandSamKirkland
committed
v4.1.0
Cert issue - Fixes #149 and Fixes #127 Exceptions now bubble up - Fixes #123 Resolves local-dir incorrect usage - Fixes #145
1 parent 408fa95 commit 59992de

File tree

7 files changed

+3546
-3604
lines changed

7 files changed

+3546
-3604
lines changed

‎README.md

Lines changed: 27 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ jobs:
2323
uses: actions/checkout@v2
2424

2525
- name: 📂 Sync files
26-
uses: SamKirkland/FTP-Deploy-Action@4.0.0
26+
uses: SamKirkland/FTP-Deploy-Action@4.1.0
2727
with:
2828
server: ftp.samkirkland.com
2929
username: myFtpUserName
@@ -55,21 +55,21 @@ 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 strongly recommend you store your `password` as a secret.
5757

58-
| Key Name | Required | Example | Default Value | Description |
59-
|-------------------------|----------|----------------------------|----------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------|
60-
| `server` | Yes | `ftp.samkirkland.com` | | Deployment destination server |
61-
| `username` | Yes | `[email protected]` | | FTP user name |
62-
| `password` | Yes | `CrazyUniquePassword&%123` | | FTP password, be sure to escape quotes and spaces |
63-
| `port` | No | `990` | `21` | Server port to connect to (read your web hosts docs) |
64-
| `protocol` | No | `ftps` | `ftp` | `ftp`: provides no encryption, `ftps`: full encryption newest standard (aka "explicit" ftps), `ftps-legacy`: full encryption legacy standard (aka "implicit" ftps) |
65-
| `local-dir` | No | `./myFolderToPublish/` | `./` | Folder to upload from, must end with trailing slash `/` |
66-
| `server-dir` | No | `public_html/www/` | `./` | Folder to upload to (on the server), must end with trailing slash `/` |
67-
| `state-name` | No | `folder/.sync-state.json` | `.ftp-deploy-sync-state.json` | Path and name of the state file - this file is used to track which files have been deployed |
68-
| `dry-run` | No | `true` | `false` | Prints which modifications will be made with current config options, but doesn't actually make any changes |
69-
| `dangerous-clean-slate` | No | `true` | `false` | Deletes ALL contents of server-dir, even items in excluded with 'exclude' argument |
70-
| `exclude` | No | | `.git*` `**.git*` `.git*/**` `**/.git*/**` `node_modules/**` `node_modules/**/*` | An array of glob patterns, these files will not be included in the publish/delete process. [List must be in yaml array format](#exclude-files) |
71-
| `log-level` | No | `minimal` | `standard` | `minimal`: only important info, `standard`: important info and basic file changes, `verbose`: print everything the script is doing |
72-
| `security` | No | `strict` | `loose` | `strict`: Reject any connection which is not authorized with the list of supplied CAs. `loose`: Allow connection even when the domain is not certificate |
58+
| Key Name | Required | Example | Default Value | Description |
59+
|-------------------------|----------|----------------------------|-----------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------|
60+
| `server` | Yes | `ftp.samkirkland.com` | | Deployment destination server |
61+
| `username` | Yes | `[email protected]` | | FTP user name |
62+
| `password` | Yes | `CrazyUniquePassword&%123` | | FTP password, be sure to escape quotes and spaces |
63+
| `port` | No | `990` | `21` | Server port to connect to (read your web hosts docs) |
64+
| `protocol` | No | `ftps` | `ftp` | `ftp`: provides no encryption, `ftps`: full encryption newest standard (aka "explicit" ftps), `ftps-legacy`: full encryption legacy standard (aka "implicit" ftps) |
65+
| `local-dir` | No | `./myFolderToPublish/` | `./` | Folder to upload from, must end with trailing slash `/` |
66+
| `server-dir` | No | `public_html/www/` | `./` | Folder to upload to (on the server), must end with trailing slash `/` |
67+
| `state-name` | No | `folder/.sync-state.json` | `.ftp-deploy-sync-state.json` | Path and name of the state file - this file is used to track which files have been deployed |
68+
| `dry-run` | No | `true` | `false` | Prints which modifications will be made with current config options, but doesn't actually make any changes |
69+
| `dangerous-clean-slate` | No | `true` | `false` | Deletes ALL contents of server-dir, even items in excluded with 'exclude' argument |
70+
| `exclude` | No | | `**/.git*` `**/.git*/**` `**/node_modules/**` | An array of glob patterns, these files will not be included in the publish/delete process. [List must be in yaml array format](#exclude-files) |
71+
| `log-level` | No | `minimal` | `standard` | `minimal`: only important info, `standard`: important info and basic file changes, `verbose`: print everything the script is doing |
72+
| `security` | No | `strict` | `loose` | `strict`: Reject any connection which is not authorized with the list of supplied CAs. `loose`: Allow connection even when the domain is not certificate |
7373

7474

7575
# Common Examples
@@ -98,7 +98,7 @@ jobs:
9898
npm run build
9999
100100
- name: 📂 Sync files
101-
uses: SamKirkland/FTP-Deploy-Action@4.0.0
101+
uses: SamKirkland/FTP-Deploy-Action@4.1.0
102102
with:
103103
server: ftp.samkirkland.com
104104
username: myFtpUserName
@@ -118,7 +118,7 @@ jobs:
118118
uses: actions/checkout@v2
119119
120120
- name: 📂 Sync files
121-
uses: SamKirkland/FTP-Deploy-Action@4.0.0
121+
uses: SamKirkland/FTP-Deploy-Action@4.1.0
122122
with:
123123
server: ftp.samkirkland.com
124124
username: myFtpUserName
@@ -141,7 +141,7 @@ jobs:
141141
uses: actions/checkout@v2
142142
143143
- name: 📂 Sync files
144-
uses: SamKirkland/FTP-Deploy-Action@4.0.0
144+
uses: SamKirkland/FTP-Deploy-Action@4.1.0
145145
with:
146146
server: ftp.samkirkland.com
147147
username: myFtpUserName
@@ -163,17 +163,16 @@ jobs:
163163
uses: actions/checkout@v2
164164
165165
- name: 📂 Sync files
166-
uses: SamKirkland/FTP-Deploy-Action@4.0.0
166+
uses: SamKirkland/FTP-Deploy-Action@4.1.0
167167
with:
168168
server: ftp.samkirkland.com
169169
username: myFtpUserName
170170
password: ${{ secrets.password }}
171-
exclude: .git*
172-
- **.git*
173-
- .git*/**
174-
- **/.git*/**
175-
- node_modules/**
176-
- node_modules/**/*
171+
exclude:
172+
- **/.git*
173+
- **/.git*/**
174+
- **/node_modules/**
175+
- fileToExclude.txt
177176
```
178177

179178
_Want another example? Let me know by creating a [github issue](https://github.com/SamKirkland/FTP-Deploy-Action/issues/new)_
@@ -237,7 +236,8 @@ Git files are excluded by default! If you customize the `exclude` option make su
237236
You can use the `exclude` option to ignore specific files/folders from the publish. Keep in mind you will need to re-add the default exclude options if you want to keep them. For example the below option excludes all `.txt` files.
238237

239238
```yml
240-
exclude: '*.txt'
239+
exclude:
240+
- *.txt
241241
```
242242

243243
</details>

‎action.yml

Lines changed: 46 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -1,49 +1,49 @@
1-
name: 'FTP Deploy'
2-
description: 'Automate deploying websites and more with this GitHub action'
3-
author: 'Sam Kirkland'
1+
name: "FTP Deploy"
2+
description: "Automate deploying websites and more with this GitHub action via FTP and FTPS"
3+
author: "Sam Kirkland"
44
inputs:
5-
server:
6-
required: true
7-
description: 'ftp server'
8-
username:
9-
required: true
10-
description: 'ftp username'
11-
password:
12-
required: true
13-
description: 'ftp password'
14-
port:
15-
required: false
16-
description: 'Server port to connect to (read your web hosts docs)'
17-
protocol:
18-
required: false
19-
description: 'protocol to deploy with - ftp, ftps, or ftps-legacy'
20-
local-dir:
21-
required: false
22-
description: 'Folder to upload from, must end with trailing slash /'
23-
server-dir:
24-
required: false
25-
description: 'Path to upload to on the server. Must end with trailing slash /'
26-
state-name:
27-
required: false
28-
description: 'Path and name of the state file - this file is used to track which files have been deployed'
29-
dry-run:
30-
required: false
31-
description: 'Prints which modifications will be made with current config options, but doesnt actually make any changes'
32-
dangerous-clean-slate:
33-
required: false
34-
description: 'Deletes ALL contents of server-dir, even items in excluded with exclude argument'
35-
exclude:
36-
required: false
37-
description: 'An array of glob patterns, these files will not be included in the publish/delete process'
38-
log-level:
39-
required: false
40-
description: 'How verbose should the information be - warn, info, debug'
41-
security:
42-
required: false
43-
description: 'strict or loose'
5+
server:
6+
required: true
7+
description: "ftp server"
8+
username:
9+
required: true
10+
description: "ftp username"
11+
password:
12+
required: true
13+
description: "ftp password"
14+
port:
15+
required: false
16+
description: "Server port to connect to (read your web hosts docs)"
17+
protocol:
18+
required: false
19+
description: "protocol to deploy with - ftp, ftps, or ftps-legacy"
20+
local-dir:
21+
required: false
22+
description: "Folder to upload from, must end with trailing slash /"
23+
server-dir:
24+
required: false
25+
description: "Path to upload to on the server. Must end with trailing slash /"
26+
state-name:
27+
required: false
28+
description: "Path and name of the state file - this file is used to track which files have been deployed"
29+
dry-run:
30+
required: false
31+
description: "Prints which modifications will be made with current config options, but doesnt actually make any changes"
32+
dangerous-clean-slate:
33+
required: false
34+
description: "Deletes ALL contents of server-dir, even items in excluded with exclude argument"
35+
exclude:
36+
required: false
37+
description: "An array of glob patterns, these files will not be included in the publish/delete process"
38+
log-level:
39+
required: false
40+
description: "How verbose should the information be - minimal, standard, or verbose"
41+
security:
42+
required: false
43+
description: "strict or loose"
4444
runs:
45-
using: 'node12'
46-
main: 'dist/index.js'
45+
using: "node12"
46+
main: "dist/index.js"
4747
branding:
48-
icon: 'upload-cloud'
49-
color: 'orange'
48+
icon: "upload-cloud"
49+
color: "orange"

0 commit comments

Comments
 (0)