v4.3.5

Update migration.md (#389 )
Improved pagination, add missing punctuation, delete useless separation lines, improve bullet lists, add link to README and releases page
2025-08-14 22:15:05 +00:00 · 2024-03-02 00:37:46 -06:00 · 2023-03-23 11:06:48 -05:00 · 2023-03-15 00:50:07 -05:00 · 2023-02-28 20:23:56 -06:00 · 2023-02-28 20:22:37 -06:00
10 changed files with 5284 additions and 5093 deletions
--- a/.github/workflows/ftp.yml
+++ b/.github/workflows/ftp.yml
@ -10,7 +10,7 @@ jobs:
    runs-on: ubuntu-latest
    steps:
      - name: 🚚 Get latest code
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4

      - name: 📂 Sync files
        uses: ./
--- a/.github/workflows/ftps.yml
+++ b/.github/workflows/ftps.yml
@ -10,7 +10,7 @@ jobs:
    runs-on: ubuntu-latest
    steps:
      - name: 🚚 Get latest code
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4

      - name: 📂 Sync files
        uses: ./
--- a/README.md
+++ b/README.md
@ -20,10 +20,10 @@ jobs:
    runs-on: ubuntu-latest
    steps:
    - name: 🚚 Get latest code
-      uses: actions/checkout@v2
+      uses: actions/checkout@v4
    
    - name: 📂 Sync files
-      uses: SamKirkland/FTP-Deploy-Action@4.3.0
+      uses: SamKirkland/FTP-Deploy-Action@v4.3.5
      with:
        server: ftp.samkirkland.com
        username: myFtpUserName
@ -33,7 +33,7 @@ jobs:
 ---

 ### Requirements
- You must have ftp access to your server. If your host requires ssh please use my web-deploy action (coming soon)
+- You must have ftp access to your server. If your host allows or requires ssh please use my [web-deploy](https://github.com/SamKirkland/web-deploy) action
 - Some web hosts change the default port (21), check with your host for your port number

 ---
@ -67,9 +67,10 @@ I strongly recommend you store your `password` as a secret.
 | `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       | [See Example](#exclude-files) | [See Example](#exclude-files) | An array of glob patterns, these files will not be included in the publish/delete process. [List MUST be in this 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). |
+| `exclude`               | No       | [See Example](#exclude-files) | [See Example](#exclude-files) | An array of glob patterns, these files will not be included in the publish/delete process. [List MUST be in this 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%0D&tests=.github%2F%0D&tests=.git%2Ftest%0D&tests=.gitattributes%0D&tests=.gitignore%0D&tests=.git%2Fconfig%0D&tests=.git%2Ftest%2Ftest&tests=.github%2Fworkflows%2Fmain.yml&tests=node_modules%2Ffolder%2F%0D&tests=node_modules%2Fotherfolder%2F%0D&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                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
+| `timeout`               | No       | `60000`                       | `30000`                       | Timeout in milliseconds for FTP operations                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |


 # Common Examples
@ -85,12 +86,12 @@ jobs:
    runs-on: ubuntu-latest
    steps:
    - name: 🚚 Get latest code
-      uses: actions/checkout@v2
+      uses: actions/checkout@v4

-    - name: Use Node.js 14
+    - name: Use Node.js 16
      uses: actions/setup-node@v2
      with:
-        node-version: '14'
+        node-version: '16'
      
    - name: 🔨 Build Project
      run: |
@ -98,7 +99,7 @@ jobs:
        npm run build
    
    - name: 📂 Sync files
-      uses: SamKirkland/FTP-Deploy-Action@4.3.0
+      uses: SamKirkland/FTP-Deploy-Action@v4.3.5
      with:
        server: ftp.samkirkland.com
        username: myFtpUserName
@ -115,10 +116,10 @@ jobs:
    runs-on: ubuntu-latest
    steps:
    - name: 🚚 Get latest code
-      uses: actions/checkout@v2
+      uses: actions/checkout@v4

    - name: 📂 Sync files
-      uses: SamKirkland/FTP-Deploy-Action@4.3.0
+      uses: SamKirkland/FTP-Deploy-Action@v4.3.5
      with:
        server: ftp.samkirkland.com
        username: myFtpUserName
@ -138,10 +139,10 @@ jobs:
    runs-on: ubuntu-latest
    steps:
    - name: 🚚 Get latest code
-      uses: actions/checkout@v2
+      uses: actions/checkout@v4

    - name: 📂 Sync files
-      uses: SamKirkland/FTP-Deploy-Action@4.3.0
+      uses: SamKirkland/FTP-Deploy-Action@v4.3.5
      with:
        server: ftp.samkirkland.com
        username: myFtpUserName
@ -160,10 +161,10 @@ jobs:
    runs-on: ubuntu-latest
    steps:
    - name: 🚚 Get latest code
-      uses: actions/checkout@v2
+      uses: actions/checkout@v4

    - name: 📂 Sync files
-      uses: SamKirkland/FTP-Deploy-Action@4.3.0
+      uses: SamKirkland/FTP-Deploy-Action@v4.3.5
      with:
        server: ftp.samkirkland.com
        username: myFtpUserName
--- a/action.yml
+++ b/action.yml
@ -41,9 +41,12 @@ inputs:
  security:
    required: false
    description: "strict or loose"
+  timeout:
+    required: false
+    description: "Timeout in milliseconds for FTP operations"
 runs:
-  using: "node12"
+  using: "node20"
  main: "dist/index.js"
 branding:
  icon: "upload-cloud"
-  color: "orange"
+  color: "blue"
--- a/dist/index.js
+++ b/dist/index.js
--- a/jest.config.js
+++ b/jest.config.js
@ -1,3 +0,0 @@
-module.exports = {
-    preset: "ts-jest"
-};
--- a/migration.md
+++ b/migration.md
@ -1,8 +1,9 @@
-# Migrating from v4.1.0 to v4.2.0
+# How to migrate between versions

-`v4.2.0` parses the `exclude` option in a more standard way.
+## Migrating from v4.1.0 to v4.2.0
+
+`v4.2.0` parses the `exclude` option in a more standard way. Going forward the `exclude` option **must** be in the following format:

-Going forward the `exclude` option **must** be in the following format
 ```yml
 exclude: |
  **/.git*
@ -11,28 +12,29 @@ exclude: |
  fileToExclude.txt
 ```

---
-
-# Migrating from v3 to v4
+## Migrating from v3 to v4

 Migrating from v3 to v4 should be fairly straightforward. Version 4 was designed with speed and ease of initial setup in mind. Going forward version 4 will be the only supported version.

-#### Those who can't upgrade
-Most features have been carried forward and improved upon. However, some features did not make the cut.
+### Those who can't upgrade
+
+Most features have been carried forward and improved upon. However, some features did not make the cut:
 - **`sftp` is no longer supported**. If you have `sftp` access you are using `ssh`, that means you have access to a much more modern and capable protocol. I plan on releasing a separate github action that will deploy over `sftp`/`ssh` using `rsync`. Until then you can continue using version 3.
 - The `include` argument has been removed. I didn't see much need for it in the initial release. If you need this feature please create a support ticket.

---
-
 ### 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.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
-    * `ftp-server` was split into 4 arguments. `server`, `port`, `protocol`, and `server-dir`. Transfer your config to these options as needed.
-    * `ftp-username` was renamed to `username`
-    * `ftp-password` was renamed to `password`
-    * `local-dir` and `server-dir` now **must** end with `/`
-    * `git-ftp-args` and `known-hosts` arguments were removed
+1. Remove `with: fetch-depth: 2`. It is no longer needed and removing it will _slightly_ speed up deployments.
+2. Change the version to `v4.X.X`, for example `SamKirkland/FTP-Deploy-Action@v4.3.5` (please check the [README](https://github.com/SamKirkland/FTP-Deploy-Action/blob/master/README.md) or the [releases page](https://github.com/SamKirkland/FTP-Deploy-Action/releases/latest) for the 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:
+    - `ftp-server` was split into 4 arguments:
+        - `server`
+        - `port`
+        - `protocol`
+        - `server-dir`
+    - `ftp-username` was renamed to `username`.
+    - `ftp-password` was renamed to `password`.
+    - `local-dir` and `server-dir` now **must** end with `/`.
+    - `git-ftp-args` and `known-hosts` arguments were removed.
--- a/package-lock.json
+++ b/package-lock.json
--- a/package.json
+++ b/package.json
@ -1,6 +1,6 @@
 {
  "name": "ftp-deploy-action",
-  "version": "4.3.0",
+  "version": "4.3.5",
  "private": true,
  "description": "Automate deploying websites and more with this GitHub action",
  "main": "dist/index.js",
@ -22,20 +22,23 @@
  "author": "Sam Kirkland",
  "license": "MIT",
  "dependencies": {
-    "@actions/core": "^1.6.0",
-    "@samkirkland/ftp-deploy": "^1.2.1",
-    "@types/jest": "^27.0.2",
-    "jest": "^27.2.5",
-    "ts-jest": "^27.0.5",
-    "ts-node-dev": "^1.1.8"
+    "@actions/core": "^1.9.1",
+    "@samkirkland/ftp-deploy": "^1.2.4",
+    "@types/jest": "^29.4.1",
+    "jest": "^29.5.0",
+    "ts-jest": "^29.0.5",
+    "ts-node-dev": "^2.0.0"
  },
  "devDependencies": {
-    "@types/node": "^14.0.27",
-    "@typescript-eslint/eslint-plugin": "^4.28.0",
-    "@typescript-eslint/parser": "^4.33.0",
-    "@vercel/ncc": "^0.31.1",
-    "eslint": "^7.29.0",
-    "eslint-plugin-jest": "^24.3.6",
-    "typescript": "^4.4.3"
+    "@types/node": "^20.11.24",
+    "@typescript-eslint/eslint-plugin": "^5.33.1",
+    "@typescript-eslint/parser": "^5.33.1",
+    "@vercel/ncc": "^0.34.0",
+    "eslint": "^8.22.0",
+    "eslint-plugin-jest": "^26.8.7",
+    "typescript": "^4.7.4"
+  },
+  "jest": {
+    "preset": "ts-jest"
  }
 }
--- a/src/main.ts
+++ b/src/main.ts
@ -18,7 +18,8 @@ async function runDeployment() {
      "dangerous-clean-slate": optionalBoolean("dangerous-clean-slate", core.getInput("dangerous-clean-slate")),
      "exclude": optionalStringArray("exclude", core.getMultilineInput("exclude")),
      "log-level": optionalLogLevel("log-level", core.getInput("log-level")),
-      "security": optionalSecurity("security", core.getInput("security"))
+      "security": optionalSecurity("security", core.getInput("security")),
+      "timeout": optionalInt("timeout", core.getInput("timeout"))
    };

    await deploy(args);
Author	SHA1	Message	Date
Sam Kirkland	8e83cea867	v4.3.5	2024-03-02 00:37:46 -06:00
Davide Trainini	c15ea8f529	Update migration.md (#389 ) Improved pagination, add missing punctuation, delete useless separation lines, improve bullet lists, add link to README and releases page	2023-03-23 11:06:48 -05:00
Sam Kirkland	8a24039354	v4.3.4 (#385 ) - updated basic-ftp - new vx.x.x tags	2023-03-15 00:50:07 -05:00
Sam Kirkland	89e533f02c	Merge pull request #352 from Trainax/glob-tester-link-fix Glob tester README link fix	2023-02-28 20:23:56 -06:00
Sam Kirkland	cf1b406626	Update README.md	2023-02-28 20:22:37 -06:00
Sam Kirkland	60edb12d91	Merge pull request #342 from Trainax/master Update actions/checkout to v3	2023-01-20 01:23:24 -06:00
Davide Trainini	28fb6c755c	Glob tester README link fix	2022-12-15 17:42:38 +01:00
Davide Trainini	08c527ecdf	Update actions/checkout to v3	2022-12-08 18:47:03 +01:00
Sam Kirkland	cfcb39fa3c	Merge pull request #321 from wcoder/patch-1 Update default timeout info	2022-12-02 10:45:56 -06:00
SamKirkland	1d198bef28	v4.3.3	2022-12-02 10:44:37 -06:00
Sam Kirkland	b8e4443bb0	Merge pull request #338 from the-snowwhite/nodejs_update Update from node12 to node16	2022-12-02 10:30:34 -06:00
the-snowwhite	84f66893ce	Update from node12 to node16 Signed-off-by: the-snowwhite <producer@holotronic.dk>	2022-11-18 21:07:09 +01:00
Yauheni Pakala	0734c4dc18	Update default timeout info Based on latest `3c410ee1b4/README.md`	2022-09-12 23:26:17 +03:00
SamKirkland	ec28745b59	blue marketplace icon	2022-09-03 17:40:42 -05:00
SamKirkland	1b21034a8d	v4.3.2	2022-09-03 17:37:57 -05:00
Sam Kirkland	ed91728692	Merge pull request #317 from Marvimoto/patch-1 Add timeout to valid inputs to resolve #316	2022-08-30 09:06:05 -05:00
Marvimoto	118eb423de	Add timeout to valid inputs	2022-08-29 19:14:03 +02:00
Sam Kirkland	e8964f3093	Merge pull request #313 from SamKirkland/4.3.1 4.3.1	2022-08-21 21:28:39 -05:00
SamKirkland	f458cc0704	Merge branch 'master' into 4.3.1	2022-08-21 21:24:37 -05:00
Sam Kirkland	01dea7c17f	Merge pull request #282 from unverbraucht/master Allow setting the timeout.	2022-08-21 21:24:08 -05:00
SamKirkland	16956be3a6	4.3.1 release Upgrade basic-ftp library Update npm libraries Resolves #308	2022-08-21 21:21:46 -05:00
Kevin Read	4f0dc298db	Allow setting the timeout.	2022-04-19 14:36:22 +02:00