Skip to content

Commit 8af1c17

Browse files
authored
docs: clarify nodejs16 requirement + fix command (#1152)
1 parent d7326db commit 8af1c17

File tree

2 files changed

+4
-1
lines changed

2 files changed

+4
-1
lines changed

Diff for: CONTRIBUTING.md

+3
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,9 @@ The following tools need to be installed on your system prior to starting workin
7777

7878
First, [fork](https://docs.github.com/en/get-started/quickstart/fork-a-repo) the repository, and then run the following commands to clone and initialize the repository locally.
7979

80+
> **Note**
81+
> In order for the commands below to work you need Node.js `16.x` and npm `8.x`
82+
8083
```console
8184
git clone https://github.com/{your-account}/aws-lambda-powertools-typescript.git
8285
cd aws-lambda-powertools-typescript

Diff for: package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
"test": "npm t -ws",
1616
"commit": "commit",
1717
"package": "npm run package",
18-
"setup-local": "npm ci --foreground-scripts && cd examples/cdk && npm ci && cd ../../examples/sam && npm ci && cd ../../layer-publisher && npm ci && cd ../.. && npm run init-environment",
18+
"setup-local": "export PROJECT_ROOT=$(pwd) && npm ci --foreground-scripts && cd $PROJECT_ROOT/examples/cdk && npm ci && cd $PROJECT_ROOT/examples/sam && npm ci && cd $PROJECT_ROOT/layer-publisher && npm ci && cd $PROJECT_ROOT/ && npm run init-environment",
1919
"build": "npm run build -ws",
2020
"postversion": "git push && git push --tags",
2121
"docs-website-build-run": "npm run docs-buildDockerImage && npm run docs-runLocalDocker",

0 commit comments

Comments
 (0)