Add link to glob testing tool to readme

Fixes #179

.github/workflows/ftp.yml

@@ -2,7 +2,7 @@ name: FTP Test
 
 on:
   push:
-    branches: [ master ]
+    branches: [master]
 
 jobs:
   deploy:
@@ -10,7 +10,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: 🚚 Get latest code
-        uses: actions/checkout@v2.3.2
+        uses: actions/checkout@v2
 
       - name: 📂 Sync files
         uses: ./
@@ -18,4 +18,3 @@ jobs:
           server: ftp.samkirkland.com
           username: test@samkirkland.com
           password: ${{ secrets.ftp_password }}
-

.github/workflows/ftps.yml

@@ -2,7 +2,7 @@ name: FTPS Test
 
 on:
   push:
-    branches: [ master ]
+    branches: [master]
 
 jobs:
   deploy:
@@ -10,7 +10,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: 🚚 Get latest code
-        uses: actions/checkout@v2.3.2
+        uses: actions/checkout@v2
 
       - name: 📂 Sync files
         uses: ./
@@ -19,4 +19,3 @@ jobs:
           username: test@samkirkland.com
           password: ${{ secrets.ftp_password }}
           protocol: ftps
-          security: strict

README.md

@@ -20,10 +20,10 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - name: 🚚 Get latest code
-      uses: actions/checkout@v2.3.2
+      uses: actions/checkout@v2
     
     - name: 📂 Sync files
-      uses: SamKirkland/FTP-Deploy-Action@4.0.0
+      uses: SamKirkland/FTP-Deploy-Action@4.1.0
       with:
         server: ftp.samkirkland.com
         username: myFtpUserName
@@ -56,18 +56,18 @@ To add a `secret` go to the `Settings` tab in your project then select `Secrets`
 I strongly recommend you store your `password` as a secret.
 
 | Key Name                | Required | Example                    | Default Value                                 | Description                                                                                                                                                        |
-|-------------------------|----------|----------------------------|---------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+|-------------------------|----------|----------------------------|-----------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------|
 | `server`                | Yes      | `ftp.samkirkland.com`      |                                               | Deployment destination server                                                                                                                                      |
 | `username`              | Yes      | `username@samkirkland.com` |                                               | FTP user name                                                                                                                                                      |
 | `password`              | Yes      | `CrazyUniquePassword&%123` |                                               | FTP password, be sure to escape quotes and spaces                                                                                                                  |
 | `port`                  | No       | `990`                      | `21`                                          | Server port to connect to (read your web hosts docs)                                                                                                               |
 | `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) |
-| `local-dir`             | No       | `./myFolderToPublish/`     | `./`                                                    | Path to upload to on the server, must end with trailing slash `/`                                                                                                  |
-| `server-dir`            | No       | `public_html/www/`         | `./`                                                    | Folder to upload from, must end with trailing slash `/`                                                                                                            |
+| `local-dir`             | No       | `./myFolderToPublish/`     | `./`                                          | Folder to upload from, must end with trailing slash `/`                                                                                                            |
+| `server-dir`            | No       | `public_html/www/`         | `./`                                          | Folder to upload to (on the server), must end with trailing slash `/`                                                                                              |
 | `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                                                                        |
 | `dry-run`               | No       | `true`                     | `false`                                       | Prints which modifications will be made with current config options, but doesn't actually make any changes                                                         |
 | `dangerous-clean-slate` | No       | `true`                     | `false`                                       | Deletes ALL contents of server-dir, even items in excluded with 'exclude' argument                                                                                 |
-| `exclude`               | No       |                            | `[.git*, .git*/**, node_modules/**, node_modules/**/*]` | An array of glob patterns, these files will not be included in the publish/delete process                                                                          |
+| `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). You can use [a glob tester](https://www.digitalocean.com/community/tools/glob?comments=true&glob=%2A%2A%2F.git%2A%2F%2A%2A&matches=false&tests=test%2Fsam&tests=.git%2F&tests=.github%2F&tests=.git%2Ftest&tests=.gitattributes&tests=.gitignore&tests=.git%2Fconfig&tests=.git%2Ftest%2Ftest&tests=.github%2Fworkflows%2Fmain.yml&tests=test%2F.git%2Fworkflows%2Fmain.yml&tests=node_modules%2Ffolder%2F&tests=node_modules%2Fotherfolder%2F&tests=subfolder%2Fnode_modules%2F) to test your pattern(s).                     |
 | `log-level`             | No       | `minimal`                  | `standard`                                    | `minimal`: only important info, `standard`: important info and basic file changes, `verbose`: print everything the script is doing                                 |
 | `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           |
 
@@ -85,7 +85,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - name: 🚚 Get latest code
-      uses: actions/checkout@v2.3.2
+      uses: actions/checkout@v2
 
     - name: Use Node.js 12
       uses: actions/setup-node@v2-beta
@@ -98,7 +98,7 @@ jobs:
         npm run build
     
     - name: 📂 Sync files
-      uses: SamKirkland/FTP-Deploy-Action@4.0.0
+      uses: SamKirkland/FTP-Deploy-Action@4.1.0
       with:
         server: ftp.samkirkland.com
         username: myFtpUserName
@@ -115,10 +115,10 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - name: 🚚 Get latest code
-      uses: actions/checkout@v2.3.2
+      uses: actions/checkout@v2
 
     - name: 📂 Sync files
-      uses: SamKirkland/FTP-Deploy-Action@4.0.0
+      uses: SamKirkland/FTP-Deploy-Action@4.1.0
       with:
         server: ftp.samkirkland.com
         username: myFtpUserName
@@ -138,10 +138,10 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - name: 🚚 Get latest code
-      uses: actions/checkout@v2.3.2
+      uses: actions/checkout@v2
 
     - name: 📂 Sync files
-      uses: SamKirkland/FTP-Deploy-Action@4.0.0
+      uses: SamKirkland/FTP-Deploy-Action@4.1.0
       with:
         server: ftp.samkirkland.com
         username: myFtpUserName
@@ -149,6 +149,32 @@ jobs:
         dry-run: true
 ```
 
+#### Exclude files
+Excludes files
+```yml
+on: push
+name: 🚀 Deploy website on push
+jobs:
+  web-deploy:
+    name: 🎉 Deploy
+    runs-on: ubuntu-latest
+    steps:
+    - name: 🚚 Get latest code
+      uses: actions/checkout@v2
+
+    - name: 📂 Sync files
+      uses: SamKirkland/FTP-Deploy-Action@4.1.0
+      with:
+        server: ftp.samkirkland.com
+        username: myFtpUserName
+        password: ${{ secrets.password }}
+        exclude:
+          - **/.git*
+          - **/.git*/**
+          - **/node_modules/**
+          - fileToExclude.txt
+```
+
 _Want another example? Let me know by creating a [github issue](https://github.com/SamKirkland/FTP-Deploy-Action/issues/new)_
 
 ---
@@ -210,7 +236,8 @@ Git files are excluded by default! If you customize the `exclude` option make su
 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.
 
 ```yml
-exclude: '*.txt'
+exclude:
+ - *.txt
 ```
 
 </details>

action.yml

@@ -1,49 +1,49 @@
-name: 'FTP Deploy'
-description: 'Automate deploying websites and more with this GitHub action'
-author: 'Sam Kirkland'
+name: "FTP Deploy"
+description: "Automate deploying websites and more with this GitHub action via FTP and FTPS"
+author: "Sam Kirkland"
 inputs:
   server:
     required: true
-      description: 'ftp server'
+    description: "ftp server"
   username:
     required: true
-      description: 'ftp username'
+    description: "ftp username"
   password:
     required: true
-      description: 'ftp password'
+    description: "ftp password"
   port:
     required: false
-      description: 'Server port to connect to (read your web hosts docs)'
+    description: "Server port to connect to (read your web hosts docs)"
   protocol:
     required: false
-      description: 'protocol to deploy with - ftp, ftps, or ftps-legacy'
+    description: "protocol to deploy with - ftp, ftps, or ftps-legacy"
   local-dir:
     required: false
-      description: 'Folder to upload from, must end with trailing slash /'
+    description: "Folder to upload from, must end with trailing slash /"
   server-dir:
     required: false
-      description: 'Path to upload to on the server. Must end with trailing slash /'
+    description: "Path to upload to on the server. Must end with trailing slash /"
   state-name:
     required: false
-      description: 'Path and name of the state file - this file is used to track which files have been deployed'
+    description: "Path and name of the state file - this file is used to track which files have been deployed"
   dry-run:
     required: false
-      description: 'Prints which modifications will be made with current config options, but doesnt actually make any changes'
+    description: "Prints which modifications will be made with current config options, but doesnt actually make any changes"
   dangerous-clean-slate:
     required: false
-      description: 'Deletes ALL contents of server-dir, even items in excluded with exclude argument'
+    description: "Deletes ALL contents of server-dir, even items in excluded with exclude argument"
   exclude:
     required: false
-      description: 'An array of glob patterns, these files will not be included in the publish/delete process'
+    description: "An array of glob patterns, these files will not be included in the publish/delete process"
   log-level:
     required: false
-      description: 'How verbose should the information be - warn, info, debug'
+    description: "How verbose should the information be - minimal, standard, or verbose"
   security:
     required: false
-      description: 'strict or loose'
+    description: "strict or loose"
 runs:
-  using: 'node12'
-  main: 'dist/index.js'
+  using: "node12"
+  main: "dist/index.js"
 branding:
-  icon: 'upload-cloud'
-  color: 'orange'
+  icon: "upload-cloud"
+  color: "orange"

migration.md

@@ -12,7 +12,7 @@ Most features have been carried forward and improved upon. However, some feature
 ### How to upgrade
 
 1) Remove `with: fetch-depth: 2`. It is no longer needed and removing it will _slightly_ speed up deployments.
-2) Change the version to `4.X.X`, for example `SamKirkland/FTP-Deploy-Action@4.0.0` (please check readme for latest version)
+2) Change the version to `4.X.X`, for example `SamKirkland/FTP-Deploy-Action@4.1.0` (please check readme for latest version)
 3) If you have a `.git-ftp-include` file you should delete it. Version 4 tracks files differently and no longer needs this config file.
 4) If you have a `.git-ftp-ignore` file, you should transfer the options to the new `exclude` argument. _Note: Version 4 excludes any `.git*` and `node_modules/` files/folders by default_
 5) Update your arguments to reflect the following changes

package.json

@@ -1,6 +1,6 @@
 {
   "name": "ftp-deploy-action",
-  "version": "4.0.0",
+  "version": "4.1.0",
   "private": true,
   "description": "Automate deploying websites and more with this GitHub action",
   "main": "dist/index.js",
@@ -14,27 +14,28 @@
     "url": "git+https://github.com/SamKirkland/FTP-Deploy-Action.git"
   },
   "keywords": [
+    "ftp",
     "website deploy",
     "continuous integration",
-    "ftp",
     "ftps"
   ],
   "author": "Sam Kirkland",
   "license": "MIT",
   "dependencies": {
-    "@actions/core": "^1.2.6",
-    "@samkirkland/ftp-deploy": "^1.0.3",
-    "@types/jest": "^26.0.15",
-    "jest": "^26.6.3",
-    "ts-jest": "^26.4.4",
-    "ts-node-dev": "^1.0.0-pre.62"
+    "@actions/core": "^1.4.0",
+    "@samkirkland/ftp-deploy": "^1.1.0",
+    "@types/jest": "^26.0.23",
+    "jest": "^27.0.5",
+    "ts-jest": "^27.0.3",
+    "ts-node-dev": "^1.1.6"
   },
   "devDependencies": {
     "@types/node": "^14.0.27",
-    "@typescript-eslint/parser": "^4.0.1",
-    "@vercel/ncc": "^0.24.0",
-    "eslint": "^7.8.1",
-    "js-yaml": "^3.14.0",
-    "typescript": "^4.0.2"
+    "@typescript-eslint/eslint-plugin": "^4.28.0",
+    "@typescript-eslint/parser": "^4.28.0",
+    "@vercel/ncc": "^0.28.6",
+    "eslint": "^7.29.0",
+    "eslint-plugin-jest": "^24.3.6",
+    "typescript": "^4.3.4"
   }
 }

tsconfig.json

@@ -1,5 +1,6 @@
 {
   "compilerOptions": {
+    "moduleResolution": "Node",
     "target": "ES2019", /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019' or 'ESNEXT'. */
     "module": "commonjs", /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */
     "outDir": "./dist", /* Redirect output structure to the directory. */