Skip to content

Commit f6bf5cc

Browse files
authored
docs: update CONTRIBUTING.md (#27718)
I add a guide to build and test alpha packages in `CONTRIBUTING.md`. ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
1 parent 9262f99 commit f6bf5cc

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

CONTRIBUTING.md

+14
Original file line numberDiff line numberDiff line change
@@ -1079,6 +1079,20 @@ Experimental packages are used to develop new constructs and experiment with the
10791079
them as stable and including them within `aws-cdk-lib`. Once they are included in `aws-cdk-lib`, no
10801080
more breaking api changes can be made.
10811081

1082+
When you want to build an alpha package (for example, `some-package-alpha`), you can execute the following in the root of the repository to build it and it's dependencies.
1083+
1084+
```
1085+
$ npx lerna run build --scope=@aws-cdk/some-package-alpha
1086+
```
1087+
1088+
At this point, you can run build and test the alpha package.
1089+
1090+
```
1091+
$ cd packages/@aws-cdk/some-package-alpha
1092+
$ yarn build
1093+
$ yarn test
1094+
```
1095+
10821096
## Changing Cloud Assembly Schema
10831097

10841098
If you plan on making changes to the `cloud-assembly-schema` package, make sure you familiarize yourself with

0 commit comments

Comments
 (0)