retypeapp/Retype Action for FTP sync using git-ftp
Uses git-ftp to publish/sync retype documentation site to a FTP host.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| branch | The name of the branch where the Retype output will be committed to. This is required to store history of changes in contents that should be published to the FTP endpoint. Default is "retype" | no | — |
| directory | The relative path within the repo/branch where to commit the Retype output. Useful if you use GitHub pages to host from the "docs" folder on "main" branch. Defaults to root of the branch. | no | — |
| ftp-host | Hostname or IP address of the FTP server where files are to be sent. Examples: ftp.mydomain.com, 172.16.10.20 GitHub as a whole did not support ipv6 at the time this was redacted. | yes | — |
| ftp-pass | FTP password to autenticate in the FTP server with. Please provide at least this as a GitHub secret. | yes | — |
| ftp-root | Path to the directory within the FTP server to place files in. Examples: public_html, wwwroot, mydomain.com/wwwroot, / (root folder, valid depending on FTP server), . (FTP home) | yes | — |
| ftp-user | FTP username to authenticate in the FTP server with. | yes | — |
| github-token | A GitHub Token used by the action to create a pull request in cases where a new uniquely named branch is created. If the target branch exists and "update-branch" is not true, then a pull request to merge the temporary branch will be created. If this option is not set, the action may push a new branch but will not create a pull request. Default is empty. | no | — |
| update-branch | Set as true to push changes directly to the target branch, even if it already exists. This will avoid the need for the action to create a pull request. Default is false. | no | — |
Outputs
no outputs