From f6bf5cc0ecbaf81e9169c800a375116f16357924 Mon Sep 17 00:00:00 2001 From: Hiroki Yamazaki <121911537+ymhiroki@users.noreply.github.com> Date: Sat, 28 Oct 2023 00:42:06 +0900 Subject: [PATCH] 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* --- CONTRIBUTING.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4ef44c7914560..cb80a883d68e3 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1079,6 +1079,20 @@ Experimental packages are used to develop new constructs and experiment with the them as stable and including them within `aws-cdk-lib`. Once they are included in `aws-cdk-lib`, no more breaking api changes can be made. +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. + +``` +$ npx lerna run build --scope=@aws-cdk/some-package-alpha +``` + +At this point, you can run build and test the alpha package. + +``` +$ cd packages/@aws-cdk/some-package-alpha +$ yarn build +$ yarn test +``` + ## Changing Cloud Assembly Schema If you plan on making changes to the `cloud-assembly-schema` package, make sure you familiarize yourself with