Initial version released

Author: Soumyanjan Dey

.gitignore

@@ -0,0 +1 @@
+node_modules

README.md

@@ -0,0 +1,77 @@
+# FTP Swift
+
+## Overview
+
+FTP Swift is a fast and reliable solution for uploading and managing files and folders via FTP. It ensures seamless transfers with secure connections, making file management efficient and hassle-free.
+
+## Features
+
+- Automatic FTP deployment on GitHub push
+- Secure and efficient file transfers
+- Customizable local and remote directory settings
+- Supports GitHub Actions for CI/CD integration
+
+## Usage
+
+This setup uses GitHub Actions to automatically deploy your files and folders via FTP when changes are pushed to the specified branch.
+
+### Workflow Configuration
+
+The following GitHub Actions workflow (`.github/workflows/<any_file_name>.yml`) is used to deploy files via FTP:
+
+```yaml
+name: Deploy website
+on:
+  push:
+    branches: [<your_branch_name>]
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Run Custom FTP Deploy
+        uses: arwebcs/FTP-Swift@v1.0.0
+        with:
+          server: ${{ secrets.FTP_HOST }}
+          username: ${{ secrets.FTP_USERNAME }}
+          password: ${{ secrets.FTP_PASSWORD }}
+          port: ${{ secrets.FTP_PORT }}
+          local-dir: ""
+          remote-dir: ""
+```
+
+## Setup Instructions
+
+1. **Create GitHub Secrets:**
+
+   - Go to your repository settings on GitHub.
+   - Navigate to **Secrets and variables** > **Actions**.
+   - Add the following secrets:
+
+2. **Configure FTP Server Details:**
+
+   - Update the `local-dir` and `remote-dir` fields in the workflow file as needed.
+
+3. **Commit and Push Changes:**
+
+   - Ensure the `.github/workflows/<any_file_name>.yml` file is added to your repository.
+   - Push your code to the specified branch to trigger the deployment.
+
+## Environment Variables
+
+The following environment variables must be set up as GitHub Secrets for the FTP deployment to work properly:
+
+| Variable     | Mandatory | Default Value                   | Description                                            |
+| ------------ | --------- | ------------------------------- | ------------------------------------------------------ |
+| FTP_HOST     | ✅ Yes    | N/A                             | The hostname or IP address of the FTP server.          |
+| FTP_USERNAME | ✅ Yes    | N/A                             | The username used to authenticate with the FTP server. |
+| FTP_PASSWORD | ✅ Yes    | N/A                             | The password for the FTP user account.                 |
+| FTP_PORT     | ❌ No     | For non-SSL : 21, For SSL : 990 | The port used for the FTP connection.                  |
+
+## Support
+
+For issues and feature requests, please open an issue on the repository:  
+[GitHub Issues](https://github.com/arwebcs/FTP-Swift/issues)

action.yml

@@ -0,0 +1,58 @@
+name: "FTP Swift"
+description: "Securely uploads files and folders to an FTP server. Supports authentication, custom ports, and directory selection."
+branding:
+  icon: "upload-cloud"
+  color: "blue"
+author: "Soumyanjan Dey"
+
+inputs:
+  server:
+    description: "FTP server address"
+    required: true
+  username:
+    description: "FTP username"
+    required: true
+  password:
+    description: "FTP password"
+    required: true
+  port:
+    description: "FTP port"
+    required: false
+    default: "21"
+  local-dir:
+    description: "Local directory to upload"
+    required: false
+    default: "./"
+  remote-dir:
+    description: "Remote directory on FTP server"
+    required: false
+    default: "/"
+
+outputs:
+  status:
+    description: "Indicates whether the FTP upload was successful or failed."
+    value: "${{ steps.ftp-upload.outputs.status }}"
+  uploaded-files:
+    description: "Comma-separated list of files successfully uploaded to the FTP server."
+    value: "${{ steps.ftp-upload.outputs.uploaded-files }}"
+
+
+runs:
+  using: "composite"
+  steps:
+    - name: Install dependencies
+      run: npm ci --prefix ${{ github.action_path }}
+      shell: bash
+
+    - name: Run FTP Upload
+      env:
+        FTP_SERVER: ${{ inputs.server }}
+        FTP_USERNAME: ${{ inputs.username }}
+        FTP_PASSWORD: ${{ inputs.password }}
+        FTP_PORT: ${{ inputs.port }}
+        LOCAL_DIR: ${{ inputs.local-dir }}
+        REMOTE_DIR: ${{ inputs.remote-dir }}
+      run: node ${{ github.action_path }}/index.js
+      shell: bash
+
+  

index.js

@@ -0,0 +1,49 @@
+const ftp = require("basic-ftp");
+
+async function uploadFiles() {
+  const client = new ftp.Client();
+  client.ftp.verbose = true;
+
+  const server = process.env.FTP_SERVER;
+  const username = process.env.FTP_USERNAME;
+  const password = process.env.FTP_PASSWORD;
+  const localDir = process.env.LOCAL_DIR || ".";
+  const remoteDir = process.env.REMOTE_DIR || "/";
+
+  const isSSL = server.startsWith("ftps://");
+  const port = process.env.FTP_PORT
+    ? parseInt(process.env.FTP_PORT, 10)
+    : isSSL
+    ? 990
+    : 21;
+  const secure = isSSL;
+
+  const cleanServer = server.replace(/^ftps?:\/\//, "");
+
+  console.log(
+    `Connecting to FTP server: ${cleanServer} on port ${port} (Secure: ${secure})`
+  );
+
+  try {
+    await client.access({
+      host: cleanServer,
+      user: username,
+      password: password,
+      secure: secure,
+      port: port,
+    });
+
+    console.log("Connected! Uploading...");
+    await client.ensureDir(remoteDir);
+    await client.uploadFromDir(localDir);
+
+    console.log(`Upload successful! Files have been uploaded to: ${remoteDir}`);
+  } catch (err) {
+    console.error("FTP Upload failed:", err);
+    process.exit(1);
+  } finally {
+    client.close();
+  }
+}
+
+uploadFiles();

package-lock.json

@@ -0,0 +1,12 @@
+{
+  "name": "ftp-swift",
+  "version": "1.0.0",
+  "description": "FTP Swift is a fast and reliable solution for uploading and managing files and folders via FTP. It ensures seamless transfers with secure connections, making file management efficient and hassle-free.",
+  "main": "index.js",
+  "scripts": {
+    "start": "node index.js"
+  },
+  "dependencies": {
+    "basic-ftp": "^5.0.4"
+  }
+}