Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(docs): Document how outdir works when passed to App and while using CDKTF CLI #3463

Merged
merged 1 commit into from
Jan 24, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions packages/cdktf/lib/app.ts
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,15 @@ export interface AppConfig {
/**
* The directory to output Terraform resources.
*
* If you are using the CDKTF CLI, this value is automatically set from one of the following three sources:
* - The `-o` / `--output` CLI option
* - The `CDKTF_OUTDIR` environment variable
* - The `outdir` key in `cdktf.json`
*
* If you are using the CDKTF CLI and want to set a different value here, you will also need to set the same value via one of the three ways specified above.
*
* The most common case to set this value is when you are using the CDKTF library directly (e.g. when writing unit tests).
*
* @default - CDKTF_OUTDIR if defined, otherwise "cdktf.out"
*/
readonly outdir?: string;
Expand Down
10 changes: 10 additions & 0 deletions website/docs/cdktf/api-reference/csharp.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12442,6 +12442,16 @@ public string Outdir { get; set; }

The directory to output Terraform resources.

If you are using the CDKTF CLI, this value is automatically set from one of the following three sources:

- The `-o` / `--output` CLI option
- The `CDKTF_OUTDIR` environment variable
- The `outdir` key in `cdktf.json`

If you are using the CDKTF CLI and want to set a different value here, you will also need to set the same value via one of the three ways specified above.

The most common case to set this value is when you are using the CDKTF library directly (e.g. when writing unit tests).

---

##### `SkipBackendValidation`<sup>Optional</sup> <a name="SkipBackendValidation" id="cdktf.AppConfig.property.skipBackendValidation"></a>
Expand Down
10 changes: 10 additions & 0 deletions website/docs/cdktf/api-reference/go.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12442,6 +12442,16 @@ Outdir *string

The directory to output Terraform resources.

If you are using the CDKTF CLI, this value is automatically set from one of the following three sources:

- The `-o` / `--output` CLI option
- The `CDKTF_OUTDIR` environment variable
- The `outdir` key in `cdktf.json`

If you are using the CDKTF CLI and want to set a different value here, you will also need to set the same value via one of the three ways specified above.

The most common case to set this value is when you are using the CDKTF library directly (e.g. when writing unit tests).

---

##### `SkipBackendValidation`<sup>Optional</sup> <a name="SkipBackendValidation" id="cdktf.AppConfig.property.skipBackendValidation"></a>
Expand Down
20 changes: 20 additions & 0 deletions website/docs/cdktf/api-reference/java.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,16 @@ Context can be read from any construct using `node.getContext(key)`.

The directory to output Terraform resources.

If you are using the CDKTF CLI, this value is automatically set from one of the following three sources:

- The `-o` / `--output` CLI option
- The `CDKTF_OUTDIR` environment variable
- The `outdir` key in `cdktf.json`

If you are using the CDKTF CLI and want to set a different value here, you will also need to set the same value via one of the three ways specified above.

The most common case to set this value is when you are using the CDKTF library directly (e.g. when writing unit tests).

---

##### `skipBackendValidation`<sup>Optional</sup> <a name="skipBackendValidation" id="cdktf.App.Initializer.parameter.skipBackendValidation"></a>
Expand Down Expand Up @@ -17243,6 +17253,16 @@ public java.lang.String getOutdir();

The directory to output Terraform resources.

If you are using the CDKTF CLI, this value is automatically set from one of the following three sources:

- The `-o` / `--output` CLI option
- The `CDKTF_OUTDIR` environment variable
- The `outdir` key in `cdktf.json`

If you are using the CDKTF CLI and want to set a different value here, you will also need to set the same value via one of the three ways specified above.

The most common case to set this value is when you are using the CDKTF library directly (e.g. when writing unit tests).

---

##### `skipBackendValidation`<sup>Optional</sup> <a name="skipBackendValidation" id="cdktf.AppConfig.property.skipBackendValidation"></a>
Expand Down
20 changes: 20 additions & 0 deletions website/docs/cdktf/api-reference/python.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,16 @@ Context can be read from any construct using `node.getContext(key)`.

The directory to output Terraform resources.

If you are using the CDKTF CLI, this value is automatically set from one of the following three sources:

- The `-o` / `--output` CLI option
- The `CDKTF_OUTDIR` environment variable
- The `outdir` key in `cdktf.json`

If you are using the CDKTF CLI and want to set a different value here, you will also need to set the same value via one of the three ways specified above.

The most common case to set this value is when you are using the CDKTF library directly (e.g. when writing unit tests).

---

##### `skip_backend_validation`<sup>Optional</sup> <a name="skip_backend_validation" id="cdktf.App.Initializer.parameter.skipBackendValidation"></a>
Expand Down Expand Up @@ -17991,6 +18001,16 @@ outdir: str

The directory to output Terraform resources.

If you are using the CDKTF CLI, this value is automatically set from one of the following three sources:

- The `-o` / `--output` CLI option
- The `CDKTF_OUTDIR` environment variable
- The `outdir` key in `cdktf.json`

If you are using the CDKTF CLI and want to set a different value here, you will also need to set the same value via one of the three ways specified above.

The most common case to set this value is when you are using the CDKTF library directly (e.g. when writing unit tests).

---

##### `skip_backend_validation`<sup>Optional</sup> <a name="skip_backend_validation" id="cdktf.AppConfig.property.skipBackendValidation"></a>
Expand Down
10 changes: 10 additions & 0 deletions website/docs/cdktf/api-reference/typescript.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12435,6 +12435,16 @@ public readonly outdir: string;

The directory to output Terraform resources.

If you are using the CDKTF CLI, this value is automatically set from one of the following three sources:

- The `-o` / `--output` CLI option
- The `CDKTF_OUTDIR` environment variable
- The `outdir` key in `cdktf.json`

If you are using the CDKTF CLI and want to set a different value here, you will also need to set the same value via one of the three ways specified above.

The most common case to set this value is when you are using the CDKTF library directly (e.g. when writing unit tests).

---

##### `skipBackendValidation`<sup>Optional</sup> <a name="skipBackendValidation" id="cdktf.AppConfig.property.skipBackendValidation"></a>
Expand Down
Loading