Actions/FTP-Deploy-Action
1
Fork 0
mirror of https://github.com/SamKirkland/FTP-Deploy-Action.git synced 2025-08-14 14:05:05 +00:00
Code Issues Packages Projects Releases Wiki Activity

Updating README to reflect .yaml changes

Browse Source
This commit is contained in:
Sam Kirkland 2019-08-29 00:21:07 -05:00 committed by GitHub
parent d6a63fd397
commit fe67ba0caa
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 59 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

79
README.md
View File

@ -4,45 +4,84 @@ Automate deploying websites and more with this GitHub action.
![Action](images/action.png)
### Usage
### Usage (Your_Project/.github/workflows/push.yaml)
```
action "FTP-Deploy-Action" {
uses = "SamKirkland/FTP-Deploy-Action@master"
secrets = ["FTP_USERNAME", "FTP_PASSWORD", "FTP_SERVER"]
}
on: push
name: Publish Website
jobs:
fTP-Deploy-Action:
name: FTP-Deploy-Action
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@master
- name: FTP-Deploy-Action
uses: SamKirkland/FTP-Deploy-Action@master
env:
FTP_PASSWORD: ${{ secrets.FTP_PASSWORD }}
FTP_SERVER: ${{ secrets.FTP_SERVER }}
FTP_USERNAME: ${{ secrets.FTP_USERNAME }}
```
1. Select the repository you want to add the action to
2. Select the actions tab `(currently only for beta testers)`
3. Select `Create a new workflow`
4. Select `Edit new file`
5. Paste the above code into the bottom of the file
6. Go back to the `Visual editor`
7. Click edit on the `FTP-Deploy-Action`
8. In the `secrets` section add the required params
3. Select `Blank workflow file` or `Set up a workflow yourself`, if you don't see these options manually create a yaml file `Your_Project/.github/workflows/push.yaml`
4. Paste the above code into your file and save
7. Now you need to add a few keys to the `secrets` section in your project, the following are required at a minimum. To add a `secret` go to the `Settings` tab in your project then select `Secrets`. Add a new `Secret` for each of the following
* FTP_USERNAME
* FTP_PASSWORD
* FTP_SERVER
* (see optional settings below)
### Settings
- Options
- __FTP Username__: ${FTP_USERNAME}
- __FTP Password__: ${FTP_PASSWORD}
- __FTP Server__: ${FTP_SERVER}
- __(Optional) Local Dir__: ${LOCAL_DIR}
- __(Optional) Remote Dir__: ${REMOTE_DIR}
- Set actions by editing the action then adding them in the `secrets` section:
- ![Action](images/env.png)
To add a `secret` go to the `Settings` tab in your project then select `Secrets`. Add a new `Secret` for each of the following
| Secret Key Name | Required? | Example | Default | Description |
|-----------------|-----------|-----------------------------|---------|-------------|
| FTP_USERNAME | Yes | git-action@samkirkland.com | N/A | FTP account username |
| FTP_PASSWORD | Yes | CrazyUniquePassword&%123 | N/A | FTP account password |
| FTP_SERVER | Yes | ftp.samkirkland.com | N/A | FTP server name (you may need to specify a port) |
| LOCAL_DIR | No | | / | The local folder to copy, defaults to root project folder |
| REMOTE_DIR | No | | / | The remote folder to copy to, deafults to root FTP folder (I recommend you configure this on your server side instead of here) |
### Explanation of steps
## Common Examples
### Building and deploying a javascript website
```
on: push
name: Build and Publish Website
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v1
- name: Project setup
run: npm install
- name: Compile javascript
run: npm run build
- name : FTP-Deploy
uses: SamKirkland/FTP-Deploy-Action@master
env:
FTP_SERVER : ${{ secrets.FTP_SERVER }}
FTP_PASSWORD : ${{ secrets.FTP_PASSWORD }}
FTP_USERNAME : ${{ secrets.FTP_USERNAME }}
```
### What does this action do exactly?
- This action is triggered by a `event` on your repo
- A docker image based on `mwienk/docker-lftp` is spun up on github servers
- The docker container compresses your code into a tar.gz file
- The file is then uploaded to the remote server
- The file is then un-zipped
### Deprecated main.workflow config (used for beta/legacy apps that haven't been migrated to .yaml workflows yet)
```
action "FTP-Deploy-Action" {
uses = "SamKirkland/FTP-Deploy-Action@master"
secrets = ["FTP_USERNAME", "FTP_PASSWORD", "FTP_SERVER"]
}
```
### Debugging locally
###### Instructions for windows
- Install docker for windows