Actions/FTP-Deploy-Action
1
Fork 0
mirror of https://github.com/SamKirkland/FTP-Deploy-Action.git synced 2025-10-31 09:34:01 +00:00
Code Issues Packages Projects Releases Wiki Activity

v4.1.0

Browse Source 
Cert issue - Fixes #149 and Fixes #127
Exceptions now bubble up - Fixes #123
Resolves local-dir incorrect usage - Fixes #145
This commit is contained in:
SamKirkland 2021-06-22 23:59:51 -05:00
parent 408fa95d1f
commit 59992de6c6
7 changed files with 3553 additions and 3611 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

54
README.md
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.0.0 uses: SamKirkland/FTP-Deploy-Action@4.1.0
with: with:
server: ftp.samkirkland.com server: ftp.samkirkland.com
username: myFtpUserName username: myFtpUserName
@ -55,21 +55,21 @@ 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*` `.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) | | `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) |
| `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 |
# Common Examples # Common Examples
@ -98,7 +98,7 @@ jobs:
npm run build npm run build
- name: 📂 Sync files - name: 📂 Sync files
uses: SamKirkland/FTP-Deploy-Action@4.0.0 uses: SamKirkland/FTP-Deploy-Action@4.1.0
with: with:
server: ftp.samkirkland.com server: ftp.samkirkland.com
username: myFtpUserName username: myFtpUserName
@ -118,7 +118,7 @@ jobs:
uses: actions/checkout@v2 uses: actions/checkout@v2
- name: 📂 Sync files - name: 📂 Sync files
uses: SamKirkland/FTP-Deploy-Action@4.0.0 uses: SamKirkland/FTP-Deploy-Action@4.1.0
with: with:
server: ftp.samkirkland.com server: ftp.samkirkland.com
username: myFtpUserName username: myFtpUserName
@ -141,7 +141,7 @@ jobs:
uses: actions/checkout@v2 uses: actions/checkout@v2
- name: 📂 Sync files - name: 📂 Sync files
uses: SamKirkland/FTP-Deploy-Action@4.0.0 uses: SamKirkland/FTP-Deploy-Action@4.1.0
with: with:
server: ftp.samkirkland.com server: ftp.samkirkland.com
username: myFtpUserName username: myFtpUserName
@ -163,17 +163,16 @@ jobs:
uses: actions/checkout@v2 uses: actions/checkout@v2
- name: 📂 Sync files - name: 📂 Sync files
uses: SamKirkland/FTP-Deploy-Action@4.0.0 uses: SamKirkland/FTP-Deploy-Action@4.1.0
with: with:
server: ftp.samkirkland.com server: ftp.samkirkland.com
username: myFtpUserName username: myFtpUserName
password: ${{ secrets.password }} password: ${{ secrets.password }}
exclude: .git* exclude:
- **.git* - **/.git*
- .git*/** - **/.git*/**
- **/.git*/** - **/node_modules/**
- node_modules/** - fileToExclude.txt
- node_modules/**/*
``` ```
_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)_
@ -237,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. 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 ```yml
exclude: '*.txt' exclude:
- *.txt
``` ```
</details> </details>

92
action.yml
View File

@ -1,49 +1,49 @@
name: 'FTP Deploy' name: "FTP Deploy"
description: 'Automate deploying websites and more with this GitHub action' description: "Automate deploying websites and more with this GitHub action via FTP and FTPS"
author: 'Sam Kirkland' author: "Sam Kirkland"
inputs: inputs:
server: server:
required: true required: true
description: 'ftp server' description: "ftp server"
username: username:
required: true required: true
description: 'ftp username' description: "ftp username"
password: password:
required: true required: true
description: 'ftp password' description: "ftp password"
port: port:
required: false 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: protocol:
required: false required: false
description: 'protocol to deploy with - ftp, ftps, or ftps-legacy' description: "protocol to deploy with - ftp, ftps, or ftps-legacy"
local-dir: local-dir:
required: false required: false
description: 'Folder to upload from, must end with trailing slash /' description: "Folder to upload from, must end with trailing slash /"
server-dir: server-dir:
required: false 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: state-name:
required: false 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: dry-run:
required: false 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: dangerous-clean-slate:
required: false 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: exclude:
required: false 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: log-level:
required: false required: false
description: 'How verbose should the information be - warn, info, debug' description: "How verbose should the information be - minimal, standard, or verbose"
security: security:
required: false required: false
description: 'strict or loose' description: "strict or loose"
runs: runs:
using: 'node12' using: "node12"
main: 'dist/index.js' main: "dist/index.js"
branding: branding:
icon: 'upload-cloud' icon: "upload-cloud"
color: 'orange' color: "orange"

1654
dist/index.js vendored
View File

File diff suppressed because it is too large Load Diff

2
migration.md
View File

@ -12,7 +12,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.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. 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

5334
package-lock.json generated
View File

File diff suppressed because it is too large Load Diff

27
package.json
View File

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

1
tsconfig.json
View File

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