Convert artifact plugin to rsync plugin.

A friendly-fork of buildkite-plugins/rsync-buildkite-plugin to support
`rsync`-based file transfers.

Author: Alex Ford

.buildkite/pipeline.yml

@@ -1,64 +1,75 @@
-# Artifacts Buildkite Plugin
+# `rsync` Buildkite Plugin
 
-A [Buildkite plugin](https://buildkite.com/docs/agent/v3/plugins) for uploading and downloading artifacts.
+A [Buildkite plugin](https://buildkite.com/docs/agent/v3/plugins) for
+performing file transfers via
+[`rsync`](https://linux.die.net/man/1/rsync). The plugin invokes `rsync`
+in the `pre` or `post` command phase to provide an artifact-like upload
+and download capacity.
 
-## Uploading artifacts
+## Examples
 
-This functionality duplicates the [artifact_paths]() property in the pipeline yaml files.
+Upload a build product directory into a build-specific output directory on
+a remote store:
 
 ```yml
 steps:
   - plugins:
-      artifacts#v1.2.0:
-        upload: "log/**/*.log"
+      uw-ipd/rsync#v0.1:
+        post: "-Rrv bin remote:/build/${BUILDKITE_BUILD_NUMBER}"
 ```
 
-or
+Upload a glob of files, note that artifact-path extended globbing (eg.
+`path/**/*.log`) is *not* supported:
 
 ```yml
 steps:
   - plugins:
-      artifacts#v1.2.0:
-        upload: [ "log/**/*.log", "debug/*.error" ]
+      uw-ipd/rsync#v0.1:
+        post: "-Rrv log/*/*.log remote:/build/${BUILDKITE_BUILD_NUMBER}"
 ```
 
-## Downloading artifacts
-
-This downloads artifacts matching globs to the local filesystem. See [downloading artifacts](https://buildkite.com/docs/agent/cli-artifact#downloading-artifacts) for more details.
+`${VAR}` is interpolated at pipeline-upload time, not step evaluation
+time. Use `$${VAR}` to perform step-time interpolation of environment
+variables:
 
 ```yml
 steps:
   - plugins:
-      artifacts#v1.2.0:
-        download: "log/**/*.log"
+      uw-ipd/rsync#v0.1:
+        post: "-Rrv bin remote:/build/$${BUILDKITE_JOB_ID}"
 ```
 
-or
+Upload via multiple invocations:
 
 ```yml
 steps:
   - plugins:
-      artifacts#v1.2.0:
-        download: [ "log/**/*.log", "debug/*.error" ]
+      uw-ipd/rsync#v0.1:
+        post:
+         - "-Rrv bin remote:/build/${BUILDKITE_BUILD_NUMBER}"
+         - "-Rrv logs/*/*.txt remote:/build/${BUILDKITE_BUILD_NUMBER}/$${BUILDKITE_JOB_ID}"
 ```
 
-## Configuration
-
-### `upload`
+Download *before* a command executes via the `pre` step:
 
-A glob pattern, or array of glob patterns, for files to upload.
-
-### `download`
+```yml
+steps:
+  - plugins:
+      uw-ipd/rsync#v0.1:
+        pre: "-rv remote:/build/ccache ./ccache"
+```
 
-A glob pattern, or array of glob patterns, for files to download.
+## Configuration
 
-### `step` (optional)
+### `pre`
 
-The job UUID or name to download the artifact from.
+An rsync argument string, or array of rsync argument strings, to be
+executed before `command`.
 
-### `build` (optional)
+### `post`
 
-The build UUID to download the artifact from.
+An rsync argument string, or array of rsync argument strings, to be
+executed after `command`.
 
 ## License
 

.github/boomper.yml

@@ -1,58 +1,32 @@
 #!/bin/bash
 set -euo pipefail
 
-if [[ "${BUILDKITE_PLUGIN_ARTIFACTS_DEBUG:-false}" =~ (true|on|1) ]] ; then
+if [[ "${BUILDKITE_PLUGIN_RSYNC_DEBUG:-false}" =~ (true|on|1) ]] ; then
   echo "--- :hammer: Enabling debug mode"
   set -x
 fi
 
-args=()
-
-if [[ -n "${BUILDKITE_PLUGIN_ARTIFACTS_JOB:-}" ]] ; then
-  args+=("--job" "${BUILDKITE_PLUGIN_ARTIFACTS_JOB}")
-fi
-
 paths=()
 
-if [[ -n "${BUILDKITE_PLUGIN_ARTIFACTS_UPLOAD:-}" ]] ; then
-  paths+=("$BUILDKITE_PLUGIN_ARTIFACTS_UPLOAD")
+if [[ -n "${BUILDKITE_PLUGIN_RSYNC_POST:-}" ]] ; then
+  paths+=("$BUILDKITE_PLUGIN_RSYNC_POST")
 fi
 
 while IFS='=' read -r path _ ; do
-  if [[ $path =~ ^(BUILDKITE_PLUGIN_ARTIFACTS_UPLOAD_[0-9]+) ]] ; then
+  if [[ $path =~ ^(BUILDKITE_PLUGIN_RSYNC_POST_[0-9]+) ]] ; then
     paths+=("${!path}")
   fi
 done < <(env | sort)
 
-workdir=${BUILDKITE_PLUGIN_ARTIFACTS_WORKDIR:-.}
+workdir=${BUILDKITE_PLUGIN_RSYNC_WORKDIR:-.}
 
 pushd "${workdir}"
 trap popd EXIT
 
-if [ "${#paths[@]}" -eq 1 ]; then
-  if [ "${#args[@]}" -gt 0 ]; then
-    echo "--- Uploading artifacts with args: ${args[*]}"
+echo "--- rsync-ing "
 
-    buildkite-agent artifact upload "${args[@]}" "${paths[*]}"
-  else
-    echo "--- Uploading artifacts"
-
-    buildkite-agent artifact upload "${paths[*]}"
-  fi
-elif [ "${#paths[@]}" -gt 1 ]; then
-  if [ "${#args[@]}" -gt 0 ]; then
-    echo "--- Uploading artifacts with args: ${args[*]}"
-
-    for path in "${paths[@]}"
-      do
-        buildkite-agent artifact upload "${args[@]}" "$path"
-      done
-  else
-    echo "--- Uploading artifacts"
-
-    for path in "${paths[@]}"
-      do
-        buildkite-agent artifact upload "$path"
-      done
-  fi
-fi
+for path in "${paths[@]}"
+  do
+    ## `eval` to support step-time varibles in the command
+    eval rsync $path
+  done

.github/release-drafter.yml

@@ -1,59 +1,32 @@
 #!/bin/bash
 set -euo pipefail
 
-if [[ "${BUILDKITE_PLUGIN_ARTIFACTS_DEBUG:-false}" =~ (true|on|1) ]] ; then
+if [[ "${BUILDKITE_PLUGIN_RSYNC_DEBUG:-false}" =~ (true|on|1) ]] ; then
   echo "--- :hammer: Enabling debug mode"
   set -x
 fi
 
-args=()
-
-if [[ -n "${BUILDKITE_PLUGIN_ARTIFACTS_STEP:-}" ]] ; then
-  args+=("--step" "${BUILDKITE_PLUGIN_ARTIFACTS_STEP}")
-fi
-
-if [[ -n "${BUILDKITE_PLUGIN_ARTIFACTS_BUILD:-}" ]] ; then
-  args+=("--build" "${BUILDKITE_PLUGIN_ARTIFACTS_BUILD}")
-fi
-
 paths=()
 
-if [[ -n "${BUILDKITE_PLUGIN_ARTIFACTS_DOWNLOAD:-}" ]] ; then
-  paths+=("$BUILDKITE_PLUGIN_ARTIFACTS_DOWNLOAD")
+if [[ -n "${BUILDKITE_PLUGIN_RSYNC_PRE:-}" ]] ; then
+  paths+=("$BUILDKITE_PLUGIN_RSYNC_PRE")
 fi
 
 while IFS='=' read -r path _ ; do
-  if [[ $path =~ ^(BUILDKITE_PLUGIN_ARTIFACTS_DOWNLOAD_[0-9]+) ]] ; then
+  if [[ $path =~ ^(BUILDKITE_PLUGIN_RSYNC_PRE_[0-9]+) ]] ; then
     paths+=("${!path}")
   fi
 done < <(env | sort)
 
-workdir="${BUILDKITE_PLUGIN_ARTIFACTS_WORKDIR:-.}"
+workdir=${BUILDKITE_PLUGIN_RSYNC_WORKDIR:-.}
 
-if [ "${#paths[@]}" -eq 1 ]; then
-  if [ "${#args[@]}" -gt 0 ]; then
-    echo "--- Downloading artifacts with args: ${args[*]}"
+pushd "${workdir}"
+trap popd EXIT
 
-    buildkite-agent artifact download "${args[@]}" "${paths[*]}" "${workdir}"
-  else
-    echo "--- Downloading artifacts"
+echo "--- rsync-ing "
 
-    buildkite-agent artifact download "${paths[*]}" "${workdir}"
-  fi
-elif [ "${#paths[@]}" -gt 1 ]; then
-  if [ "${#args[@]}" -gt 0 ]; then
-    echo "--- Downloading artifacts with args: ${args[*]}"
-
-    for path in "${paths[@]}"
-      do
-        buildkite-agent artifact download "${args[@]}" "$path" "${workdir}"
-      done
-  else
-    echo "--- Downloading artifacts"
-
-    for path in "${paths[@]}"
-      do
-        buildkite-agent artifact download "$path" "${workdir}"
-      done
-  fi
-fi
+for path in "${paths[@]}"
+  do
+    ## `eval` to support step-time varibles in the command
+    eval rsync $path
+  done