You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
chore: document new --unstable protocol for CLI features (#31612)
New protocol for `--unstable` is documented here and being used in #31611
----
*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
Copy file name to clipboardExpand all lines: packages/aws-cdk/README.md
+16
Original file line number
Diff line number
Diff line change
@@ -33,6 +33,8 @@ The AWS CDK Toolkit provides the `cdk` command-line interface that can be used t
33
33
-[SSO Support](#sso-support)
34
34
-[Configuration](#configuration)
35
35
-[Running in CI](#running-in-ci)
36
+
-[Stability](#stability)
37
+
-[Changing the default TypeScript transpiler](#Changing-the-default-TypeScript-transpiler)
36
38
37
39
38
40
This module is part of the [AWS Cloud Development Kit](https://github.com/aws/aws-cdk) project.
@@ -1067,6 +1069,20 @@ The CLI will attempt to detect whether it is being run in CI by looking for the
1067
1069
environment variable `CI=true`. This can be forced by passing the `--ci` flag. By default the CLI
1068
1070
sends most of its logs to `stderr`, but when `ci=true` it will send the logs to `stdout` instead.
1069
1071
1072
+
### Stability
1073
+
1074
+
Sometimes the CDK team will release experimental or incremental features. In these scenarios we will
1075
+
require explicit opt-in from users via the `--unstable` flag. For example, if we are working on a new
1076
+
bootstrap feature and decide to release it incrementally, we will "hide" its functionality.
1077
+
Opting in would look something like this:
1078
+
1079
+
```bash
1080
+
cdk bootstrap --unstable='new-funky-bootstrap'
1081
+
```
1082
+
1083
+
When the feature is stabilized, explicit opt-in is no longer necessary but the feature will continue
1084
+
to work with the `--unstable` flag set.
1085
+
1070
1086
### Changing the default TypeScript transpiler
1071
1087
1072
1088
The ts-node package used to synthesize and deploy CDK apps supports an alternate transpiler that might improve transpile times. The SWC transpiler is written in Rust and has no type checking. The SWC transpiler should be enabled by experienced TypeScript developers.
0 commit comments