Skip to content

Commit 999f597

Browse files
floehopperElad Ben-Israel
authored andcommitted
docs: instructions for building superchain in contribution guide (#355)
1 parent 91853ce commit 999f597

1 file changed

Lines changed: 21 additions & 14 deletions

File tree

CONTRIBUTING.md

Lines changed: 21 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -15,19 +15,25 @@ __jsii__, it relies on the following toolchains:
1515
- [Python 3.6.5](https://www.python.org/downloads/release/python-365/)
1616
- [Ruby 2.5.1](https://www.ruby-lang.org/en/news/2018/03/28/ruby-2-5-1-released/)
1717

18-
When building on CodeBuild, these toolchains are all included in the
19-
[superchain](https://github.com/awslabs/superchain) docker image. This image can
20-
also be used locally as follows:
21-
22-
```shell
23-
eval $(aws ecr get-login --no-include-email)
24-
IMAGE=260708760616.dkr.ecr.us-east-1.amazonaws.com/superchain:latest
25-
docker pull ${IMAGE}
26-
docker run --net=host -it -v $PWD:$PWD -w $PWD ${IMAGE}
18+
Our CI/CD uses the "superchain" image from [aws-delivlib](https://github.com/awslabs/aws-delivlib).
19+
20+
This image can also be used locally like this (note that initial build may take quite some time):
21+
22+
```console
23+
$ git clone git@github.com:awslabs/aws-delivlib.git
24+
$ cd aws-delivlib/superchain
25+
$ docker build -t superchain .
26+
$ IMAGE=superchain
27+
```
28+
29+
This will get you into an interactive docker shell:
30+
31+
```console
32+
$ cd jsii # go to the root of the jsii repo
33+
$ docker run --net=host -it -v $PWD:$PWD -w $PWD ${IMAGE}
2734
```
2835

29-
This will get you into an interactive docker shell. You can then run
30-
./install.sh and ./build.sh as described below.
36+
You can then run `./build.sh` as described below.
3137

3238
### Bootstrapping
3339

@@ -46,10 +52,11 @@ All modules within this repository have the following scripts:
4652
* `build` - builds the module (usually runs the TypeScript compiler).
4753
* `watch` - runs `tsc -w` which picks up changes and builds them progressively.
4854
* `test` - uses `nodeunit test/test.*.js` to run all unit tests.
49-
* `package` - emits publishable artifacts to `dist/xxx` (where "xxx" is the language)
55+
* `package` - emits publishable artifacts to `dist/<lang>`
5056

5157
Each one of these scripts can be executed either from the root of the repo using
52-
`lerna run xxx --scope <package>` or from individual modules using `npm run xxx`.
58+
`npx lerna run <script> --scope <package>` or from individual modules using
59+
`npm run <script>`.
5360

5461
### Bump
5562

@@ -84,7 +91,7 @@ jsii language bindings consist of two main components:
8491
### Runtime Client Library
8592

8693
The runtime client library should be implemented as a module under
87-
`packages/jsii-xxx-runtime` (where `xxx` is the language).
94+
`packages/jsii-<lang>-runtime`.
8895

8996
The jsii runtime client library usually includes the following components:
9097

0 commit comments

Comments
 (0)