Skip to content

Commit 844633f

Browse files
committed
fix(build): Update contributing.md and fix npm ci
Changes: - Update CONTRIBUTING.md to use > [email protected] preinstall > (cd packages/commons && npm ci); (cd packages/logger && npm ci); (cd packages/metrics && npm ci); (cd packages/tracing && npm ci); > @aws-lambda-powertools/[email protected] prepare > npm run build > @aws-lambda-powertools/[email protected] build > tsc added 586 packages, and audited 587 packages in 4s 84 packages are looking for funding run `npm fund` for details found 0 vulnerabilities > @aws-lambda-powertools/[email protected] prepare > npm run build > @aws-lambda-powertools/[email protected] build > tsc added 488 packages, and audited 489 packages in 4s 72 packages are looking for funding run `npm fund` for details found 0 vulnerabilities > @aws-lambda-powertools/[email protected] prepare > npm run build > @aws-lambda-powertools/[email protected] build > tsc added 822 packages, and audited 852 packages in 10s 91 packages are looking for funding run `npm fund` for details found 0 vulnerabilities > @aws-lambda-powertools/[email protected] prepare > npm run build > @aws-lambda-powertools/[email protected] build > tsc added 836 packages, and audited 859 packages in 8s 72 packages are looking for funding run `npm fund` for details found 0 vulnerabilities added 1327 packages, removed 2761 packages, changed 10 packages, and audited 1383 packages in 40s 100 packages are looking for funding run `npm fund` for details found 0 vulnerabilities - Add a preinstall task to install all of the sub packages closes aws-powertools#415
1 parent 5a03c94 commit 844633f

File tree

2 files changed

+8
-5
lines changed

2 files changed

+8
-5
lines changed

Diff for: CONTRIBUTING.md

+6-4
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ Please read through this document before submitting any issues or pull requests
77
information to effectively respond to your bug report or contribution.
88

99
## Security issue notifications
10+
1011
If you discover a potential security issue in this project we ask that you notify AWS/Amazon Security via our [vulnerability reporting page](http://aws.amazon.com/security/vulnerability-reporting/). Please do **not** create a public GitHub issue.
1112

1213
## Reporting Bugs/Feature Requests
@@ -35,7 +36,7 @@ Contributions via pull requests are much appreciated. Before sending us a pull r
3536
To send us a pull request, please follow these steps:
3637

3738
1. Fork the repository.
38-
2. Install dependencies: `npm install`
39+
2. Install dependencies: `npm ci`
3940
3. Prepare utilities like commit hooks: `npm run init-environment`
4041
4. Create a new branch to focus on the specific change you are contributing e.g. `git checkout -b improv/logger-debug-sampling`
4142
5. Run all tests, and code baseline checks: `npm run test`
@@ -54,8 +55,9 @@ You might find useful to run both the documentation website and the API referenc
5455
* **Docs website**:
5556

5657
You can build and start a local docs website by running these two commands.
57-
- `npm run docs-buildDockerImage` OR `docker build -t squidfunk/mkdocs-material ./docs/`
58-
- `npm run docs-runLocalDocker` OR `docker run --rm -it -p 8000:8000 -v ${PWD}:/docs squidfunk/mkdocs-material`
58+
59+
* `npm run docs-buildDockerImage` OR `docker build -t squidfunk/mkdocs-material ./docs/`
60+
* `npm run docs-runLocalDocker` OR `docker run --rm -it -p 8000:8000 -v ${PWD}:/docs squidfunk/mkdocs-material`
5961

6062
### Conventions
6163

@@ -89,4 +91,4 @@ TODO
8991

9092
See the [LICENSE](LICENSE) file for our project's licensing. We will ask you to confirm the licensing of your contribution.
9193

92-
We may ask you to sign a [Contributor License Agreement (CLA)](http://en.wikipedia.org/wiki/Contributor_License_Agreement) for larger changes.
94+
We may ask you to sign a [Contributor License Agreement (CLA)](http://en.wikipedia.org/wiki/Contributor_License_Agreement) for larger changes.

Diff for: package.json

+2-1
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,8 @@
2626
"docs-buildDockerImage": "docker build -t powertool-typescript/docs ./docs/",
2727
"docs-runLocalDocker": "docker run --rm -it -p 8000:8000 -v ${PWD}:/docs powertool-typescript/docs",
2828
"docs-generateApiDoc": "typedoc .",
29-
"docs-runLocalApiDoc": "npx live-server api"
29+
"docs-runLocalApiDoc": "npx live-server api",
30+
"preinstall": "(cd packages/commons && npm ci); (cd packages/logger && npm ci); (cd packages/metrics && npm ci); (cd packages/tracing && npm ci);"
3031
},
3132
"repository": {
3233
"type": "git",

0 commit comments

Comments
 (0)