requesting changes in readme.md

Open
#40 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
45/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Stale
Tech stack
docker, node.js
Domain
devops, documentation

Research direction

Open README.md and locate the multistage Docker example containing the COPY --from=build-image step. Compare it with the reported DEPLOYABLE stage, including its ARG, WORKDIR, ENTRYPOINT, and CMD, then update the example if the reported approach is appropriate and verify that the documented build and launch flow is consistent.

Written by the indexing model from the issue text.

Description

documentation

In the multistage docker script, these didn't work for me:

# Copy in the built dependencies
COPY --from=build-image ${FUNCTION_DIR} ${FUNCTION_DIR}

Doing the above resulted in:

Error: Error loading shared library libnghttp2.so.14: No such file or directory (needed by /runnable/node_modules/aws-lambda-ric/build/Release/runtime-client.node)

What worked for me is:

...

FROM build-image AS DEPLOYABLE

# Include global arg in this stage of the build
ARG FUNCTION_DIR

# Set working directory to function root directory
WORKDIR ${FUNCTION_DIR}

ENTRYPOINT ["/usr/local/bin/npx", "aws-lambda-ric"]
CMD ["app.handler"]

You might consider changing the README to use that instead?

Thanks!
Bryan

Dominant language
TypeScript
Stars
224
Forks
60
Avg merge
26m
Merged PRs (30d)
2

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from aws/aws-lambda-nodejs-runtime-interface-client

All issues in aws/aws-lambda-nodejs-runtime-interface-client

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.