Skip to content

Quickstart documentation points to the wrong build-lambdas.sh #49

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ThiagoDella opened this issue May 12, 2025 · 0 comments
Open

Quickstart documentation points to the wrong build-lambdas.sh #49

ThiagoDella opened this issue May 12, 2025 · 0 comments

Comments

@ThiagoDella
Copy link

Description

As of today the Quickstart documentation mentions under the "Setup the serverless image resizer" section that the developer should execute the bash script located at: deployment/build-lambdas.sh.

Image

Apparently there are two issues with the script:

  1. It produces zipped files with sub folders, the zip file inner structure looks like: lambdas/${lambda_name}/handler.py, which breaks the commands defined in deployment/awslocal/deploy.sh and in the terraform/main.tf files. Both of them expect the handler.py file to be at the root of the zipped file.
  2. It does not build the dependencies needed by the resize lambda. They are defined in lambdas/resize/requirements.txt and need to be built before zipping the resize lambda. Which prevents the resize lambda from working properly.

Possible solution

Fortunately this repo has another build-lambdas.sh script, this one located at: bin/build-lambdas.sh (used to be part of the deploy.sh in earlier versions). This script works as intended as it:

  • Navigates to each lambda folder for compressing the files, avoiding the wrong inner structure mentioned in my first listed issue;
  • Builds the required dependencies for the resize lambda.

It's worth noting that this script is also used by the Makefile (the build-lambdas function) and in the CI pipelines of this repo.

I can gladly make a PR moving things around but considering that the "correct" version of the build-lambdas.sh is already inside the bin folder (which makes sense) and is also used in multiple places inside this repo, it probably makes more sense to adapt the Quickstart documentation to point to the correct build-lambdas.sh and delete the other one.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant