fix: app outdir property cannot be different from CLI or cdk8s.yaml…

… file (#783)

Currently setting the `outdir` property for CDK8s app throws an error,
```
ERROR: synthesis failed, app expected to create "dist"
```

This is due to the CLI not able to recognize this change in the `outdir` in the application property. 
The value specified in the `outdir` needs to be similar to what is mentioned either in CLI's `--output` argument or the `output` property in the cdk8s.yaml file. 

Signed-off-by: Vinayak Kukreja <[email protected]>

Resolves cdk8s-team/cdk8s-cli#210

docs/java.md

@@ -217,6 +217,14 @@ App.Builder.create()
 
 The directory to output Kubernetes manifests.
 
+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.
+
 ---
 
 ##### `outputFileExtension`<sup>Optional</sup> <a name="org.cdk8s.AppProps.parameter.outputFileExtension"></a>
@@ -844,6 +852,14 @@ public java.lang.String getOutdir();
 
 The directory to output Kubernetes manifests.
 
+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.
+
 ---
 
 ##### `outputFileExtension`<sup>Optional</sup> <a name="org.cdk8s.AppProps.property.outputFileExtension"></a>

docs/python.md

@@ -225,6 +225,14 @@ cdk8s.App(
 
 The directory to output Kubernetes manifests.
 
+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.
+
 ---
 
 ##### `output_file_extension`<sup>Optional</sup> <a name="cdk8s.AppProps.parameter.output_file_extension"></a>
@@ -866,6 +874,14 @@ outdir: str
 
 The directory to output Kubernetes manifests.
 
+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.
+
 ---
 
 ##### `output_file_extension`<sup>Optional</sup> <a name="cdk8s.AppProps.property.output_file_extension"></a>
@@ -2854,6 +2870,14 @@ cdk8s.Testing.app(
 
 The directory to output Kubernetes manifests.
 
+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.
+
 ---
 
 ###### `output_file_extension`<sup>Optional</sup> <a name="cdk8s.AppProps.parameter.output_file_extension"></a>

docs/typescript.md

@@ -702,6 +702,14 @@ public readonly outdir: string;
 
 The directory to output Kubernetes manifests.
 
+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.
+
 ---
 
 ##### `outputFileExtension`<sup>Optional</sup> <a name="cdk8s.AppProps.property.outputFileExtension"></a>

src/app.ts

@@ -23,6 +23,14 @@ export interface AppProps {
   /**
    * The directory to output Kubernetes manifests.
    *
+   * 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.
+   *
    * @default - CDK8S_OUTDIR if defined, otherwise "dist"
    */
   readonly outdir?: string;