docs(cli): bundling implications on contributions#19449
Conversation
|
|
packages/aws-cdk/CONTRIBUTING.md
Outdated
| will change, and needs to be regenerated. For you, this means that: | ||
|
|
||
| 1. When you manually upgrade a dependency, you must also regenerate the document by running `yarn pkglint` inside the CLI package. | ||
| 2. When you build the CLI locally, you must ensure your dependencies are up to date by running `yarn install`. |
There was a problem hiding this comment.
To avoid confusion we should probably mention whether this means running yarn install in the CLI package directory, or just at the root level.
There was a problem hiding this comment.
@Chriscbr Added 👍 (though for our monorepo it doesn't matter)
| will change, and needs to be regenerated. For you, this means that: | ||
|
|
||
| 1. When you manually upgrade a dependency, you must also regenerate the document by running `yarn pkglint` inside the CLI package. | ||
| 2. When you build the CLI locally, you must ensure your dependencies are up to date by running `yarn install` inside the CLI package. |
There was a problem hiding this comment.
yarn install only means something at workspace level, no?
|
Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork). |
AWS CodeBuild CI Report
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository |
|
Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork). |
Added a good to know section about CLI bundling to the contribution guide.
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license