Merge pull request softprops#72 from Veetaha/feat/skip-zipping

Rename SKIP_ZIPPING=1 -> PACKAGE=false

Author: softprops

CHANGELOG.md

@@ -2,7 +2,7 @@
 
 * Put unzipped `boostrap` and `boostrap.debug` files under `target/lambda/${PROFILE}/output/${BIN}` dir
 to allow for using these artifacts without an intermediate `.zip` file creation step.
-* Introduce `$SKIP_ZIPPING` env var. Setting `-e SKIP_ZIPPING=1` prevents `.zip` archive from
+* Introduce `$PACKAGE` env var. Setting `-e PACKAGE=false` prevents `.zip` archive from
 being created and `package` hook from running.
 
 # 0.2.7-rust-1.44.1

README.md

@@ -34,7 +34,7 @@ You can pass additional flags to `cargo`, the Rust build tool, by setting the `C
 
 Unzipped `boostrap` and `boostrap.debug` files are always available
 under `target/lambda/${PROFILE}/output/${BIN}` dir. If you want only them and don't
-need a `.zip` archive (e.g. for when running lambdas locally) pass `-e SKIP_ZIPPING=1`
+need a `.zip` archive (e.g. for when running lambdas locally) pass `-e PACKAGE=false`
 flag. More on that in [local testing](#-local-testing).
 
 A typical docker run might look like the following.
@@ -91,18 +91,18 @@ Once you've built a Rust lambda function artifact, the `provided` runtime expect
 deployments of that artifact to be named "**bootstrap**". The `lambda-rust` docker image
 builds a zip file, named after the binary, containing your binary file renamed to "bootstrap" for you, but zip file creation is unnecessary for local development.
 
-In order to prevent the creation of an intermediate `.zip` artifact when testing your lambdas locally, pass `-e SKIP_ZIPPING=1` during the build. After that the necessary
+In order to prevent the creation of an intermediate `.zip` artifact when testing your lambdas locally, pass `-e PACKAGE=false` during the build. After that the necessary
 output (not zipped) is available under `target/lambda/{profile}/output/{your-lambda-binary-name}` dir.
 You will see both `bootstrap` and `bootstrap.debug` files there.
-> **⚠️ Note:** `SKIP_ZIPPING=1` prevents `package` hook from running.
+> **⚠️ Note:** `PACKAGE=false` prevents `package` hook from running.
 
 You can then invoke this bootstap executable with the lambda-ci docker image for the `provided` AWS lambda runtime with a one off container.
 
 ```sh
 # Build your function skipping the zip creation step
 # You may pass `-e PROFILE=dev` to build using dev profile, but here we use `release`
 docker run \
-    -e SKIP_ZIPPING=1 \
+    -e PACKAGE=false \
     -e BIN={your-binary-name} \
     -v ${PWD}:/code \
     -v ${HOME}/.cargo/registry:/root/.cargo/registry \

build.sh

@@ -10,6 +10,7 @@ PACKAGE_HOOK="package"
 set -eo pipefail
 mkdir -p target/lambda
 export PROFILE=${PROFILE:-release}
+export PACKAGE=${PACKAGE:-true}
 export DEBUGINFO=${DEBUGINFO}
 # cargo uses different names for target
 # of its build profiles
@@ -64,7 +65,7 @@ function package() {
     cp "${file}" "${OUTPUT_FOLDER}/bootstrap"
     cp "${file}.debug" "${OUTPUT_FOLDER}/bootstrap.debug" > 2&>/dev/null || true
 
-    if [[ -z "$SKIP_ZIPPING" ]]; then
+    if [[ "$PACKAGE" != "false" ]]; then
         zip -j "$file.zip" "${OUTPUT_FOLDER}/bootstrap"
         if test -f "$HOOKS_DIR/$PACKAGE_HOOK"; then
             echo "Running package hook"

tests/test.sh

@@ -35,11 +35,11 @@ package_all() {
     ls target/lambda/release/output/"${1}"/bootstrap.debug 2>&1
 }
 
-# test SKIP_ZIPPING=1 flag
-compile_without_zipping() {
+# test PACKAGE=false flag
+compile_without_packaging() {
     rm -rf target/lambda/release > /dev/null 2>&1
     docker run --rm \
-    -e SKIP_ZIPPING=1 \
+    -e PACKAGE=false \
     -v "${PWD}":/code \
     -v "${HOME}"/.cargo/registry:/root/.cargo/registry \
     -v "${HOME}"/.cargo/git:/root/.cargo/git \
@@ -78,7 +78,7 @@ for project in test-func test-multi-func test-func-with-hooks; do
 
     assert "it packages all bins with dev profile" package_all_dev_profile "${bin_name}"
 
-    assert "it compiles the binaries without zipping when SKIP_ZIPPING=1" compile_without_zipping "${bin_name}"
+    assert "it compiles the binaries without zipping when PACKAGE=false" compile_without_packaging "${bin_name}"
 
     assert "it packages all bins" package_all "${bin_name}"