From 98f5dd0ab5c6fa628abf0e88058e6e19e3a3ab95 Mon Sep 17 00:00:00 2001 From: Vinayak Kukreja Date: Sat, 1 Oct 2022 19:01:54 -0700 Subject: [PATCH 1/4] fix(docs): app `outdir` property cannot be different from CLI or cdk8s.yaml file Signed-off-by: Vinayak Kukreja --- src/app.ts | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/src/app.ts b/src/app.ts index 3fa2986205..47e7f45ba6 100644 --- a/src/app.ts +++ b/src/app.ts @@ -23,6 +23,13 @@ export interface AppProps { /** * The directory to output Kubernetes manifests. * + * By default, the value you pass to the CDK8s CLI's `--output` flag + * or in the `output` property of cdk8s.yaml file will be used, + * and if you change it to a different directory the CLI will fail + * to pick up the new output directory. + * + * This property is intended for internal and testing use. + * * @default - CDK8S_OUTDIR if defined, otherwise "dist" */ readonly outdir?: string; From 2da11dd64dcbcc0f07f9f291d5ec3bcce7f7c807 Mon Sep 17 00:00:00 2001 From: github-actions Date: Sun, 2 Oct 2022 02:08:33 +0000 Subject: [PATCH 2/4] chore: self mutation Signed-off-by: github-actions --- docs/java.md | 14 ++++++++++++++ docs/python.md | 21 +++++++++++++++++++++ docs/typescript.md | 7 +++++++ 3 files changed, 42 insertions(+) diff --git a/docs/java.md b/docs/java.md index ec5850e394..878cec3d5c 100644 --- a/docs/java.md +++ b/docs/java.md @@ -217,6 +217,13 @@ App.Builder.create() The directory to output Kubernetes manifests. +By default, the value you pass to the CDK8s CLI's `--output` flag +or in the `output` property of cdk8s.yaml file will be used, +and if you change it to a different directory the CLI will fail +to pick up the new output directory. + +This property is intended for internal and testing use. + --- ##### `outputFileExtension`Optional @@ -844,6 +851,13 @@ public java.lang.String getOutdir(); The directory to output Kubernetes manifests. +By default, the value you pass to the CDK8s CLI's `--output` flag +or in the `output` property of cdk8s.yaml file will be used, +and if you change it to a different directory the CLI will fail +to pick up the new output directory. + +This property is intended for internal and testing use. + --- ##### `outputFileExtension`Optional diff --git a/docs/python.md b/docs/python.md index 2832aabe7e..7be67ef1c6 100644 --- a/docs/python.md +++ b/docs/python.md @@ -225,6 +225,13 @@ cdk8s.App( The directory to output Kubernetes manifests. +By default, the value you pass to the CDK8s CLI's `--output` flag +or in the `output` property of cdk8s.yaml file will be used, +and if you change it to a different directory the CLI will fail +to pick up the new output directory. + +This property is intended for internal and testing use. + --- ##### `output_file_extension`Optional @@ -866,6 +873,13 @@ outdir: str The directory to output Kubernetes manifests. +By default, the value you pass to the CDK8s CLI's `--output` flag +or in the `output` property of cdk8s.yaml file will be used, +and if you change it to a different directory the CLI will fail +to pick up the new output directory. + +This property is intended for internal and testing use. + --- ##### `output_file_extension`Optional @@ -2854,6 +2868,13 @@ cdk8s.Testing.app( The directory to output Kubernetes manifests. +By default, the value you pass to the CDK8s CLI's `--output` flag +or in the `output` property of cdk8s.yaml file will be used, +and if you change it to a different directory the CLI will fail +to pick up the new output directory. + +This property is intended for internal and testing use. + --- ###### `output_file_extension`Optional diff --git a/docs/typescript.md b/docs/typescript.md index 117a43e12c..bc184564ee 100644 --- a/docs/typescript.md +++ b/docs/typescript.md @@ -702,6 +702,13 @@ public readonly outdir: string; The directory to output Kubernetes manifests. +By default, the value you pass to the CDK8s CLI's `--output` flag +or in the `output` property of cdk8s.yaml file will be used, +and if you change it to a different directory the CLI will fail +to pick up the new output directory. + +This property is intended for internal and testing use. + --- ##### `outputFileExtension`Optional From 492fcaef2097fc7150a200e23726e5c93758fd39 Mon Sep 17 00:00:00 2001 From: Vinayak Kukreja Date: Mon, 3 Oct 2022 16:19:08 -0700 Subject: [PATCH 3/4] address feedback Signed-off-by: Vinayak Kukreja --- src/app.ts | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/src/app.ts b/src/app.ts index 4903885007..8ab56f0d5c 100644 --- a/src/app.ts +++ b/src/app.ts @@ -23,10 +23,11 @@ export interface AppProps { /** * The directory to output Kubernetes manifests. * - * By default, the value you pass to the CDK8s CLI's `--output` flag - * or in the `output` property of cdk8s.yaml file will be used, - * and if you change it to a different directory the CLI will fail - * to pick up the new output directory. + * If you synthesize your application using `cdk8s synth`, you must + * also pass this value to the CLI using the `--output` option or + * the `output` property in the `cdk8s.yaml` configuration file. + * Otherwise, the CLI will not know about the output directory, + * and synthesis will fail. * * This property is intended for internal and testing use. * From 546c1b97baabfffca04d7547e66ad446272c3073 Mon Sep 17 00:00:00 2001 From: github-actions Date: Mon, 3 Oct 2022 23:21:29 +0000 Subject: [PATCH 4/4] chore: self mutation Signed-off-by: github-actions --- docs/java.md | 18 ++++++++++-------- docs/python.md | 27 +++++++++++++++------------ docs/typescript.md | 9 +++++---- 3 files changed, 30 insertions(+), 24 deletions(-) diff --git a/docs/java.md b/docs/java.md index 878cec3d5c..8cf8ce91c3 100644 --- a/docs/java.md +++ b/docs/java.md @@ -217,10 +217,11 @@ App.Builder.create() The directory to output Kubernetes manifests. -By default, the value you pass to the CDK8s CLI's `--output` flag -or in the `output` property of cdk8s.yaml file will be used, -and if you change it to a different directory the CLI will fail -to pick up the new output directory. +If you synthesize your application using `cdk8s synth`, you must +also pass this value to the CLI using the `--output` option or +the `output` property in the `cdk8s.yaml` configuration file. +Otherwise, the CLI will not know about the output directory, +and synthesis will fail. This property is intended for internal and testing use. @@ -851,10 +852,11 @@ public java.lang.String getOutdir(); The directory to output Kubernetes manifests. -By default, the value you pass to the CDK8s CLI's `--output` flag -or in the `output` property of cdk8s.yaml file will be used, -and if you change it to a different directory the CLI will fail -to pick up the new output directory. +If you synthesize your application using `cdk8s synth`, you must +also pass this value to the CLI using the `--output` option or +the `output` property in the `cdk8s.yaml` configuration file. +Otherwise, the CLI will not know about the output directory, +and synthesis will fail. This property is intended for internal and testing use. diff --git a/docs/python.md b/docs/python.md index 7be67ef1c6..7f93eb7eff 100644 --- a/docs/python.md +++ b/docs/python.md @@ -225,10 +225,11 @@ cdk8s.App( The directory to output Kubernetes manifests. -By default, the value you pass to the CDK8s CLI's `--output` flag -or in the `output` property of cdk8s.yaml file will be used, -and if you change it to a different directory the CLI will fail -to pick up the new output directory. +If you synthesize your application using `cdk8s synth`, you must +also pass this value to the CLI using the `--output` option or +the `output` property in the `cdk8s.yaml` configuration file. +Otherwise, the CLI will not know about the output directory, +and synthesis will fail. This property is intended for internal and testing use. @@ -873,10 +874,11 @@ outdir: str The directory to output Kubernetes manifests. -By default, the value you pass to the CDK8s CLI's `--output` flag -or in the `output` property of cdk8s.yaml file will be used, -and if you change it to a different directory the CLI will fail -to pick up the new output directory. +If you synthesize your application using `cdk8s synth`, you must +also pass this value to the CLI using the `--output` option or +the `output` property in the `cdk8s.yaml` configuration file. +Otherwise, the CLI will not know about the output directory, +and synthesis will fail. This property is intended for internal and testing use. @@ -2868,10 +2870,11 @@ cdk8s.Testing.app( The directory to output Kubernetes manifests. -By default, the value you pass to the CDK8s CLI's `--output` flag -or in the `output` property of cdk8s.yaml file will be used, -and if you change it to a different directory the CLI will fail -to pick up the new output directory. +If you synthesize your application using `cdk8s synth`, you must +also pass this value to the CLI using the `--output` option or +the `output` property in the `cdk8s.yaml` configuration file. +Otherwise, the CLI will not know about the output directory, +and synthesis will fail. This property is intended for internal and testing use. diff --git a/docs/typescript.md b/docs/typescript.md index bc184564ee..506d9f33b0 100644 --- a/docs/typescript.md +++ b/docs/typescript.md @@ -702,10 +702,11 @@ public readonly outdir: string; The directory to output Kubernetes manifests. -By default, the value you pass to the CDK8s CLI's `--output` flag -or in the `output` property of cdk8s.yaml file will be used, -and if you change it to a different directory the CLI will fail -to pick up the new output directory. +If you synthesize your application using `cdk8s synth`, you must +also pass this value to the CLI using the `--output` option or +the `output` property in the `cdk8s.yaml` configuration file. +Otherwise, the CLI will not know about the output directory, +and synthesis will fail. This property is intended for internal and testing use.