Skip to content
This repository has been archived by the owner on Jun 13, 2024. It is now read-only.

Commit

Permalink
chore: add section to pack what is needed (aws#7003)
Browse files Browse the repository at this point in the history
Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
  • Loading branch information
Niranjan Jayakar and mergify[bot] authored Mar 25, 2020
1 parent 521193a commit 910cb26
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ and let us know if it's not up-to-date (even better, submit a PR with your corr
- [Full clean build](#full-clean-build)
- [Full Docker build](#full-docker-build)
- [Partial build](#partial-build)
- [Partial pack](#partial-pack)
- [Quick Iteration](#quick-iteration)
- [Linking against this repository](#linking-against-this-repository)
- [Running integration tests in parallel](#running-integration-tests-in-parallel)
Expand Down Expand Up @@ -424,6 +425,27 @@ $ ../../../scripts/buildup
Note that `buildup` uses `foreach.sh`, which means it's resumable. If your build fails and you wish to resume, just run
`buildup --resume`. If you wish to restart, run `buildup` again.

### Partial pack

Packing involves generating CDK code in the various target languages, and packaged up ready to be published to the
respective package managers. Once in a while, these will need to be generated either to test the experience of a new
feature, or reproduce a packaging failure.

Before running this, make sure either that the CDK module and all of its dependencies are already built. See [Partial
build](#partial-build) or [Full clean build](#full-clean-build).

To package a specific module, say the `@aws-cdk/aws-ec2` module:

```console
$ cd <root-of-cdk-repo>
$ docker run --rm --net=host -it -v $PWD:$PWD -w $PWD jsii/superchain
docker$ cd packages/@aws-cdk/aws-ec2
docker$ ../../../scripts/foreach.sh --up yarn run package
docker$ exit
```

The `dist/` folder within each module contains the packaged up language artifacts.

### Quick Iteration

After you've built the modules you want to work on once, use `lr watch` for each module that you are modifying.
Expand Down

0 comments on commit 910cb26

Please sign in to comment.