mirror of
https://github.com/easingthemes/ssh-deploy.git
synced 2024-11-19 08:08:05 +08:00
[init]: Add Source dir parameter
This commit is contained in:
10
README.md
10
README.md
@@ -1,8 +1,8 @@
|
||||
# rsync deployments
|
||||
# ssh deployments
|
||||
|
||||
This GitHub Action deploys *everything* in `GITHUB_WORKSPACE` to a folder on a server via rsync over ssh.
|
||||
This GitHub Action deploys specific directory from `GITHUB_WORKSPACE` to a folder on a server via rsync over ssh.
|
||||
|
||||
This action would usually follow a build/test action which leaves deployable code in `GITHUB_WORKSPACE`.
|
||||
This action would usually follow a build/test action which leaves deployable code in `GITHUB_WORKSPACE`, eg `dist`;
|
||||
|
||||
# Required SECRETs
|
||||
|
||||
@@ -16,7 +16,9 @@ This action can receive three `ARG`s:
|
||||
|
||||
2. The second is for any `--exclude` flags and directory pairs, eg: `--exclude .htaccess --exclude /uploads/`. Use "" if none required.
|
||||
|
||||
3. The third is for the deployment target, and should be in the format: `[USER]@[HOST]:[PATH]`
|
||||
3. The third is for the source target, path relative to `$GITHUB_WORKSPACE` root, eg: `dist`
|
||||
|
||||
4. The fourth is for the deployment target, and should be in the format: `[USER]@[HOST]:[PATH]`
|
||||
|
||||
# Example usage
|
||||
|
||||
|
Reference in New Issue
Block a user