feat: allow users to specify files to include in the slug (#6)

Author: gigatim

README.md

@@ -15,6 +15,7 @@ To use this, see https://gigalixir.readthedocs.io/en/latest/modify-app/releases.
 * Easy configuration with `releases_buildpack.config` file 
 * Easy configuration with `GIGALIXIR_RELEASES_BUILDPACK_CONFIG` environment variable.
 * Support for umbrella app compilation through `app_relative_path` configuration.
+* Support for adding files to the release through `.gigalixir/releases/includes.txt` file.
 
 
 
@@ -40,6 +41,28 @@ Configuration options are applied in the following order:
 
 
 
+## Adding files to the release
+
+To add files to the release, create a `.gigalixir/releases/includes.txt`.
+The file follows the `rsync` --include-from syntax.
+
+For example:
+```
+# include a specific file
+/priv/ssl_certificate.pem
+
+# include all files in a directory
+/priv/dir/*
+
+# include all files in a directory and its subdirectories
+/priv/tree/**
+```
+
+Matching files will be available in the `/app` folder at runtime.
+Empty directories will be pruned.
+
+
+
 ## Tests
 
 Tests are available in the [test](test) directory.

bin/compile

@@ -62,6 +62,8 @@ if [ -f .profile.d/phoenix_static_buildpack_env.sh ]; then
   cp .profile.d/phoenix_static_buildpack_env.sh _build/${RELEASE_ENV}/rel/$APP/.profile.d/
 fi
 
+copy_static_files "_build/${RELEASE_ENV}/rel/${APP}"
+
 # create tarball
 mkdir -p $cache_dir/out
 rm -f $cache_dir/out/*

lib/build.sh

@@ -76,3 +76,18 @@ output_section() {
 delete_broken_symlinks() {
   find "$1" -xtype l -delete > /dev/null
 }
+
+copy_static_files() {
+  local dst_dir="$1/"
+  local includes_path="${build_dir}/.gigalixir/releases/includes.txt"
+
+  if [ -f "${includes_path}" ]; then
+    output_line ".gigalixir/releases/includes.txt file found"
+    output_section "Copying files to include in the release"
+
+    rsync -av \
+      --include='*/' --include-from="${includes_path}" --exclude='*' \
+      --prune-empty-dirs --ignore-existing \
+      "${build_dir}/" "${dst_dir}"
+  fi
+}

test/copy_static_files.sh

@@ -0,0 +1,78 @@
+#!/usr/bin/env bash
+
+set -e
+
+SCRIPT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" &> /dev/null && pwd )"
+source $SCRIPT_DIR/.test_support.sh
+
+# include source file
+source $SCRIPT_DIR/../lib/build.sh
+
+# override functions
+output_line() {
+  /bin/true
+}
+output_section() {
+  /bin/true
+}
+
+# TESTS
+######################
+suite "copy_static_files()"
+
+
+  test "no include file exists"
+    mkdir -p "${build_dir}/dir1" "${build_dir}/dir2/dir3"
+    touch "${build_dir}/file0"
+    touch "${build_dir}/dir1/file1"
+    touch "${build_dir}/dir2/file2"
+    touch "${build_dir}/dir2/dir3/file3"
+
+    copy_static_files "${build_dir}/copy"
+
+    [ ! -d "${build_dir}/copy/dir1" ]
+    [ ! -d "${build_dir}/copy/dir2" ]
+    [ ! -f "${build_dir}/copy/file0" ]
+
+  test "syncs files in pattern match"
+    mkdir -p "${build_dir}/.gigalixir/releases"
+    /bin/echo "file0" > "${build_dir}/.gigalixir/releases/includes.txt"
+
+    copy_static_files "${build_dir}/copy" > /dev/null
+
+    [ ! -d "${build_dir}/copy/dir1" ]
+    [ ! -d "${build_dir}/copy/dir2" ]
+    [ -f "${build_dir}/copy/file0" ]
+    rm -rf "${build_dir}/copy"
+
+  test "testing pattern glob"
+    /bin/echo "dir2/**" > "${build_dir}/.gigalixir/releases/includes.txt"
+
+    copy_static_files "${build_dir}/copy" > /dev/null
+
+    [ ! -d "${build_dir}/copy/dir1" ]
+    [ -f "${build_dir}/copy/dir2/file2" ]
+    [ -f "${build_dir}/copy/dir2/dir3/file3" ]
+    [ ! -f "${build_dir}/copy/file0" ]
+    rm -rf "${build_dir}/copy/dir2"
+
+  test "testing pattern match"
+    /bin/echo "dir2/*" > "${build_dir}/.gigalixir/releases/includes.txt"
+
+    copy_static_files "${build_dir}/copy" > /dev/null
+
+    [ ! -d "${build_dir}/copy/dir1" ]
+    [ -f "${build_dir}/copy/dir2/file2" ]
+    [ ! -d "${build_dir}/copy/dir2/dir3" ]
+    [ ! -f "${build_dir}/copy/file0" ]
+
+  test "does not overwrite files"
+    /bin/echo "asdf" > "${build_dir}/dir2/file2"
+
+    copy_static_files "${build_dir}/copy" > /dev/null
+
+    grep -q "asdf" "${build_dir}/copy/dir2/file2" && false
+
+
+
+PASSED_ALL_TESTS=true