Usage:

kind: pipeline
[...]
steps:
  [...]
  - name: upload
    image: elfuego/relup:1
    host: dl.example.com
    user: test
    remote_path: /upload/dl
    local_path: release
    project: acmeapp
    version: 1.0
    pwd:
      from_secret: upload_pwd
    when:
      event: [ tag ]

In this example the plugin:

• removes acmeapp-1.0-* in the folder /upload/dl/acmeapp/1.0 on the server
• removes acmeapp-latest-* in the folder /upload/dl/acmeapp
• searches in the relative release directory for files acmeapp-1.0-*
• uploads them to folder /upload/dl/acmeapp/1.0
• creates symlinks acmeapp-latest-* to them in /upload/dl/acmeapp
• creates appropriate hash files for both originals and symlinks

Plugin parameters:

host

SFTP host.

Example: host: dl.example.com

port

Optional.

SFTP port. Default is 22.

Example: port: 2222

user

SFTP user.

Example: user: test

pwd

SFTP password.

Example: pwd: test1

Example:

  pwd:
    from_secret: upload_pwd

remote_path

SFTP remote path base to upload to.

Example: remote_path: /upload/dl

local_path

A local path where release files are situated.

Example: local_path: release

project

Project name.

Example: project: acmeapp

version

Optional. Either version or version_file should be used. If used both, this one is preferred.

Project version to proceed.

Example: version: 1.0

version_file

Optional. Either version or version_file should be used. If used both, other one is preferred.

A file which contains project version to proceed.

Example: version_file: .version

hashes

Optional.

Hashes to generate. Default is sha1.

Possible values: md5, sha1, sha224, sha256, sha384, sha512, sha3_224, sha3_256, sha3_384, sha3_512

Several values should be separated by commas.

Example: hashes: md5

Example: hashes: sha1,sha256,sha512