Skip to content

Commit

Permalink
fix(build): Update contributing.md and fix npm ci (#417)
Browse files Browse the repository at this point in the history
* 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 #415

* fix(build): Update contributing.md and fix npm ci

Changes:
- Update CONTRIBUTING.md to use npm ci
- Add a preinstall task to install all of the sub packages

closes #415

* chore: leave as npm install for now

* fix(all): setup up project references

* docs: update to use npm ci
  • Loading branch information
Michael Brewer authored Jan 12, 2022
1 parent fd02acb commit 279ad98
Show file tree
Hide file tree
Showing 5 changed files with 22 additions and 4 deletions.
10 changes: 6 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ Please read through this document before submitting any issues or pull requests
information to effectively respond to your bug report or contribution.

## Security issue notifications

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.

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

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

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

* `npm run docs-buildDockerImage` OR `docker build -t squidfunk/mkdocs-material ./docs/`
* `npm run docs-runLocalDocker` OR `docker run --rm -it -p 8000:8000 -v ${PWD}:/docs squidfunk/mkdocs-material`

### Conventions

Expand Down Expand Up @@ -89,4 +91,4 @@ TODO

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

We may ask you to sign a [Contributor License Agreement (CLA)](http://en.wikipedia.org/wiki/Contributor_License_Agreement) for larger changes.
We may ask you to sign a [Contributor License Agreement (CLA)](http://en.wikipedia.org/wiki/Contributor_License_Agreement) for larger changes.
1 change: 1 addition & 0 deletions packages/commons/tsconfig.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
{
"compilerOptions": {
"composite": true,
"experimentalDecorators": true,
"noImplicitAny": true,
"target": "ES2020",
Expand Down
5 changes: 5 additions & 0 deletions packages/logger/tsconfig.json
Original file line number Diff line number Diff line change
Expand Up @@ -26,5 +26,10 @@
"types": [
"jest",
"node"
],
"references": [
{
"path": "../commons"
}
]
}
5 changes: 5 additions & 0 deletions packages/metrics/tsconfig.json
Original file line number Diff line number Diff line change
Expand Up @@ -28,5 +28,10 @@
"types": [
"jest",
"node"
],
"references": [
{
"path": "../commons"
}
]
}
5 changes: 5 additions & 0 deletions packages/tracing/tsconfig.json
Original file line number Diff line number Diff line change
Expand Up @@ -28,5 +28,10 @@
"types": [
"jest",
"node"
],
"references": [
{
"path": "../commons"
}
]
}

0 comments on commit 279ad98

Please sign in to comment.