Skip to content

Commit 72500cc

Browse files
authored
chore: add debugging instructions to README (#30014)
### Issue # (if applicable) Closes #<issue number here>. ### Reason for this change Add debugging instructions for integration test to README ### Description of changes ### Description of how you validated changes ### Checklist - [Y] My code adheres to the [CONTRIBUTING GUIDE](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md) and [DESIGN GUIDELINES](https://github.com/aws/aws-cdk/blob/main/docs/DESIGN_GUIDELINES.md) ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
1 parent bbde879 commit 72500cc

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

packages/@aws-cdk-testing/cli-integ/README.md

+25
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,31 @@ yarn build # Build the @aws-cdk-testing/cli-integ package
4646
../../../scripts/align-version.sh # Align the versions of CDK packages
4747
```
4848

49+
### Running tests with debugger
50+
51+
```json
52+
{
53+
"version": "0.2.0",
54+
"configurations": [
55+
{
56+
"type": "node",
57+
"request": "launch",
58+
"args": ["-a", "cli-integ-tests", "-t", "context in stage propagates to top"],
59+
"name": "debug integ tests",
60+
"program": "~/aws-cdk/packages/@aws-cdk-testing/cli-integ/bin/run-suite",
61+
"console": "integratedTerminal",
62+
"sourceMaps": true,
63+
"skipFiles": [ "<node_internals>/**/*" ],
64+
"stopOnEntry": false
65+
}
66+
]
67+
}
68+
```
69+
70+
1. Assuming you checked out the `aws-cdk` repository in your `~` directory, use the above `launch.json`.
71+
2. In the `"args"` value after `"-t"`, place the name of the test that you'd like to run.
72+
3. Press the VS code green arrow to launch the debugger.
73+
4974
### Running a test suite
5075

5176
You run a suite using the `bin/run-suite` tool. You must select either a version of the CLI and framework which can be `npm install`ed, or point to the root of the source tree:

0 commit comments

Comments
 (0)