Compare commits

25 Commits
4.1.0 ... 4.3.3

Author SHA1 Message Date
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
Sam Kirkland
d0aa838726 Merge pull request #265 from SamKirkland/v4.3.0-beta
Version 4.3.0
2022-02-19 15:06:06 -06:00
SamKirkland
f55279346a exclude defaults bug fix 2022-01-31 00:44:08 -06:00
SamKirkland
93a0898871 rolling back nested exclude path 2022-01-31 00:11:43 -06:00
SamKirkland
1d31526b7a v4.3.0 2022-01-30 23:37:43 -06:00
SamKirkland
d3fa328f10 550 bug fix 2022-01-30 23:36:06 -06:00
Sam Kirkland
d6ad227aa5 readme example - node version bump (12 -> 14) 2021-12-09 22:26:03 -06:00
SamKirkland
c7bb3d9877 removing clean state 2021-11-22 10:34:05 -06:00
SamKirkland
a7da5e54d2 fixing tests 2021-11-22 10:31:59 -06:00
Sam Kirkland
a9644610a0 Merge pull request #245 from SamKirkland/v4.2.0-beta
V4.2.0
2021-11-22 10:13:59 -06:00
SamKirkland
825d1b8f3b allowing no ecludes 2021-11-13 16:42:30 -06:00
SamKirkland
ba86a1bf13 v4.2.0 beta
- fixes for 550 folder issue
- updated excludes option format
2021-10-13 01:18:45 -05:00
10 changed files with 4120 additions and 3463 deletions

View File

@@ -23,7 +23,7 @@ jobs:
uses: actions/checkout@v2 uses: actions/checkout@v2
- name: 📂 Sync files - name: 📂 Sync files
uses: SamKirkland/FTP-Deploy-Action@4.1.0 uses: SamKirkland/FTP-Deploy-Action@4.3.3
with: with:
server: ftp.samkirkland.com server: ftp.samkirkland.com
username: myFtpUserName username: myFtpUserName
@@ -33,7 +33,7 @@ jobs:
--- ---
### Requirements ### 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 - Some web hosts change the default port (21), check with your host for your port number
--- ---
@@ -55,21 +55,22 @@ Keys can be added directly to your .yml config file or referenced from your proj
To add a `secret` go to the `Settings` tab in your project then select `Secrets`. 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. I strongly recommend you store your `password` as a secret.
| Key Name | Required | Example | Default Value | Description | | Key Name | Required | Example | Default Value | Description |
|-------------------------|----------|----------------------------|-----------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------| |-------------------------|----------|-------------------------------|-------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `server` | Yes | `ftp.samkirkland.com` | | Deployment destination server | | `server` | Yes | `ftp.samkirkland.com` | | Deployment destination server |
| `username` | Yes | `username@samkirkland.com` | | FTP user name | | `username` | Yes | `username@samkirkland.com` | | FTP user name |
| `password` | Yes | `CrazyUniquePassword&%123` | | FTP password, be sure to escape quotes and spaces | | `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) | | `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) | | `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/` | `./` | 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 `/` | | `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 | | `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 | | `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 | | `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/**` | 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). | | `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). |
| `log-level` | No | `minimal` | `standard` | `minimal`: only important info, `standard`: important info and basic file changes, `verbose`: print everything the script is doing | | `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 | | `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 # Common Examples
@@ -87,10 +88,10 @@ jobs:
- name: 🚚 Get latest code - name: 🚚 Get latest code
uses: actions/checkout@v2 uses: actions/checkout@v2
- name: Use Node.js 12 - name: Use Node.js 16
uses: actions/setup-node@v2-beta uses: actions/setup-node@v2
with: with:
node-version: '12' node-version: '16'
- name: 🔨 Build Project - name: 🔨 Build Project
run: | run: |
@@ -98,7 +99,7 @@ jobs:
npm run build npm run build
- name: 📂 Sync files - name: 📂 Sync files
uses: SamKirkland/FTP-Deploy-Action@4.1.0 uses: SamKirkland/FTP-Deploy-Action@4.3.3
with: with:
server: ftp.samkirkland.com server: ftp.samkirkland.com
username: myFtpUserName username: myFtpUserName
@@ -118,7 +119,7 @@ jobs:
uses: actions/checkout@v2 uses: actions/checkout@v2
- name: 📂 Sync files - name: 📂 Sync files
uses: SamKirkland/FTP-Deploy-Action@4.1.0 uses: SamKirkland/FTP-Deploy-Action@4.3.3
with: with:
server: ftp.samkirkland.com server: ftp.samkirkland.com
username: myFtpUserName username: myFtpUserName
@@ -127,7 +128,7 @@ jobs:
port: 1234 # todo replace with your web hosts ftps port port: 1234 # todo replace with your web hosts ftps port
``` ```
#### Log only dry run: Use this mode for testing #### Log only dry run: Use this option for testing
Ouputs a list of files that will be created/modified to sync your source without making any actual changes Ouputs a list of files that will be created/modified to sync your source without making any actual changes
```yml ```yml
on: push on: push
@@ -141,7 +142,7 @@ jobs:
uses: actions/checkout@v2 uses: actions/checkout@v2
- name: 📂 Sync files - name: 📂 Sync files
uses: SamKirkland/FTP-Deploy-Action@4.1.0 uses: SamKirkland/FTP-Deploy-Action@4.3.3
with: with:
server: ftp.samkirkland.com server: ftp.samkirkland.com
username: myFtpUserName username: myFtpUserName
@@ -163,18 +164,30 @@ jobs:
uses: actions/checkout@v2 uses: actions/checkout@v2
- name: 📂 Sync files - name: 📂 Sync files
uses: SamKirkland/FTP-Deploy-Action@4.1.0 uses: SamKirkland/FTP-Deploy-Action@4.3.3
with: with:
server: ftp.samkirkland.com server: ftp.samkirkland.com
username: myFtpUserName username: myFtpUserName
password: ${{ secrets.password }} password: ${{ secrets.password }}
exclude: exclude: |
- **/.git* **/.git*
- **/.git*/** **/.git*/**
- **/node_modules/** **/node_modules/**
- fileToExclude.txt fileToExclude.txt
``` ```
`exclude` has the following default value
```yml
exclude: |
**/.git*
**/.git*/**
**/node_modules/**
```
if you overwrite the default value you will probably want to respecify them
---
_Want another example? Let me know by creating a [github issue](https://github.com/SamKirkland/FTP-Deploy-Action/issues/new)_ _Want another example? Let me know by creating a [github issue](https://github.com/SamKirkland/FTP-Deploy-Action/issues/new)_
--- ---

View File

@@ -41,9 +41,12 @@ inputs:
security: security:
required: false required: false
description: "strict or loose" description: "strict or loose"
timeout:
required: false
description: "Timeout in milliseconds for FTP operations"
runs: runs:
using: "node12" using: "node16"
main: "dist/index.js" main: "dist/index.js"
branding: branding:
icon: "upload-cloud" icon: "upload-cloud"
color: "orange" color: "blue"

3005
dist/index.js vendored

File diff suppressed because it is too large Load Diff

View File

@@ -1,3 +0,0 @@
module.exports = {
preset: "ts-jest"
};

View File

@@ -1,3 +1,18 @@
# 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
```yml
exclude: |
**/.git*
**/.git*/**
**/node_modules/**
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. 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.
@@ -12,7 +27,7 @@ Most features have been carried forward and improved upon. However, some feature
### How to upgrade ### How to upgrade
1) Remove `with: fetch-depth: 2`. It is no longer needed and removing it will _slightly_ speed up deployments. 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) 2) Change the version to `4.X.X`, for example `SamKirkland/FTP-Deploy-Action@4.3.1` (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. 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_ 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 5) Update your arguments to reflect the following changes

4392
package-lock.json generated

File diff suppressed because it is too large Load Diff

View File

@@ -1,6 +1,6 @@
{ {
"name": "ftp-deploy-action", "name": "ftp-deploy-action",
"version": "4.1.0", "version": "4.3.3",
"private": true, "private": true,
"description": "Automate deploying websites and more with this GitHub action", "description": "Automate deploying websites and more with this GitHub action",
"main": "dist/index.js", "main": "dist/index.js",
@@ -22,20 +22,23 @@
"author": "Sam Kirkland", "author": "Sam Kirkland",
"license": "MIT", "license": "MIT",
"dependencies": { "dependencies": {
"@actions/core": "^1.4.0", "@actions/core": "^1.9.1",
"@samkirkland/ftp-deploy": "^1.1.0", "@samkirkland/ftp-deploy": "^1.2.2",
"@types/jest": "^26.0.23", "@types/jest": "^28.1.7",
"jest": "^27.0.5", "jest": "^28.1.3",
"ts-jest": "^27.0.3", "ts-jest": "^28.0.8",
"ts-node-dev": "^1.1.6" "ts-node-dev": "^2.0.0"
}, },
"devDependencies": { "devDependencies": {
"@types/node": "^14.0.27", "@types/node": "^14.0.27",
"@typescript-eslint/eslint-plugin": "^4.28.0", "@typescript-eslint/eslint-plugin": "^5.33.1",
"@typescript-eslint/parser": "^4.28.0", "@typescript-eslint/parser": "^5.33.1",
"@vercel/ncc": "^0.28.6", "@vercel/ncc": "^0.34.0",
"eslint": "^7.29.0", "eslint": "^8.22.0",
"eslint-plugin-jest": "^24.3.6", "eslint-plugin-jest": "^26.8.7",
"typescript": "^4.3.4" "typescript": "^4.7.4"
},
"jest": {
"preset": "ts-jest"
} }
} }

View File

@@ -1,4 +1,4 @@
import { optionalBoolean, optionalInt, optionalLogLevel, optionalProtocol, optionalSecurity, optionalString, optionalStringArray } from "./parse"; import { optionalBoolean, optionalInt, optionalLogLevel, optionalProtocol, optionalSecurity, optionalString } from "./parse";
describe("boolean", () => { describe("boolean", () => {
test("false", () => { test("false", () => {
@@ -103,33 +103,3 @@ describe("security", () => {
expect(optionalSecurity("test", "strict")).toBe("strict"); expect(optionalSecurity("test", "strict")).toBe("strict");
}); });
}); });
describe("array", () => {
test("empty", () => {
expect(optionalStringArray("test", "")).toEqual(undefined);
});
test("empty array", () => {
expect(optionalStringArray("test", "[]")).toEqual([]);
});
test(`["test.txt"]`, () => {
expect(optionalStringArray("test", "[test.txt]")).toEqual(["test.txt"]);
});
test(`[ "test.txt" ]`, () => {
expect(optionalStringArray("test", "[ test.txt ]")).toEqual(["test.txt"]);
});
test(`["test.txt", "folder/**/*"]`, () => {
expect(optionalStringArray("test", "[test.txt, folder/**/*]")).toEqual(["test.txt", "folder/**/*"]);
});
test(`["test.txt", "folder/**/*", "*other"]`, () => {
expect(optionalStringArray("test", `test.txt\n - folder/**/*\n - *other`)).toEqual(["test.txt", "folder/**/*", "*other"]);
});
test(`["test.txt", "folder/**/*", "*other"]`, () => {
expect(optionalStringArray("test", `\n - test.txt\n - folder/**/*\n - *other`)).toEqual(["test.txt", "folder/**/*", "*other"]);
});
});

View File

@@ -16,14 +16,15 @@ async function runDeployment() {
"state-name": optionalString(core.getInput("state-name")), "state-name": optionalString(core.getInput("state-name")),
"dry-run": optionalBoolean("dry-run", core.getInput("dry-run")), "dry-run": optionalBoolean("dry-run", core.getInput("dry-run")),
"dangerous-clean-slate": optionalBoolean("dangerous-clean-slate", core.getInput("dangerous-clean-slate")), "dangerous-clean-slate": optionalBoolean("dangerous-clean-slate", core.getInput("dangerous-clean-slate")),
"exclude": optionalStringArray("exclude", core.getInput("exclude")), "exclude": optionalStringArray("exclude", core.getMultilineInput("exclude")),
"log-level": optionalLogLevel("log-level", core.getInput("log-level")), "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); await deploy(args);
} }
catch (error) { catch (error: any) {
core.setFailed(error); core.setFailed(error);
} }
} }

View File

@@ -90,24 +90,14 @@ export function optionalInt(argumentName: string, rawValue: string): number | un
throw new Error(`${argumentName}: invalid parameter - you provided "${rawValue}". Try a whole number (no decimals) instead like 1234`); throw new Error(`${argumentName}: invalid parameter - you provided "${rawValue}". Try a whole number (no decimals) instead like 1234`);
} }
export function optionalStringArray(argumentName: string, rawValue: string): string[] | undefined { export function optionalStringArray(argumentName: string, rawValue: string[]): string[] | undefined {
if (rawValue.length === 0) { if (rawValue.length === 0) {
return undefined; return undefined;
} }
const valueTrim = rawValue.trim(); if (typeof rawValue === "string") {
throw new Error(`${argumentName}: invalid parameter - you provided "${rawValue}". This option expects an list in the EXACT format described in the readme`);
if (valueTrim.startsWith("[")) {
// remove [ and ] - then convert to array
return rawValue.replace(/[\[\]]/g, "").trim().split(", ").filter(str => str !== "");
} }
// split value by space and comma return rawValue;
const valueAsArrayDouble = rawValue.split(" - ").map(str => str.trim()).filter(str => str !== "");
if (valueAsArrayDouble.length) {
return valueAsArrayDouble;
}
throw new Error(`${argumentName}: invalid parameter - you provided "${rawValue}". This option excepts an array in the format [val1, val2] or val1\/n - val2`);
} }