SFTP Cache

The example Yaml configurations in this file are using the legacy 0.8 syntax. If you are using Drone 1.0 or Drone Cloud please ensure you use the appropriate 1.0 syntax. Learn more here.

Use this plugin for caching build artifacts to speed up your build times. This plugin can create and restore caches of any folders.

pipeline:
  restore_cache:
    image: appleboy/drone-sftp-cache
    server: example.com
    port: 22
    username: test
    password: test
    path: /var/cache/drone
    restore: true
    mount:
      - node_modules

  build:
    image: node:latest
    commands:
      - npm install

  rebuild_cache:
    image: appleboy/drone-sftp-cache
    server: example.com
    port: 22
    username: test
    password: test
    path: /var/cache/drone
    rebuild: true
    mount:
      - node_modules

Example configuration for login with user private key:

pipeline:
  rebuild_cache:
    image: appleboy/drone-sftp-cache
    server: example.com
    port: 22
    username: test
-   password: test
+   key: plain_text_of_user_private_key
    path: /var/cache/drone
    rebuild: true
    mount:
      - node_modules

Example configuration for creates a hash file name only based on mount path:

pipeline:
  rebuild_cache:
    image: appleboy/drone-sftp-cache
    server: example.com
    port: 22
    username: test
    password: test
+   ignore_branch: true
    path: /var/cache/drone
    rebuild: true
    mount:
      - node_modules

Parameter Reference

server

target hostname or IP

port

ssh port of target host

username

account for target host user

password

password for target host user

key

plain text of user private key

rebuild

boolean flag to trigger a rebuild

restore

boolean flag to trigger a restore

ignore_branch

boolean flag to ignore commit branch name on hash value