feat(techdocs-common): add custom docker image support

Signed-off-by: Andrew Thauer <athauer@wealthsimple.com>
2021-07-13 11:26:12 -04:00
parent 7a6a3586ac
commit d5eaab91dd
12 changed files with 303 additions and 32 deletions
@@ -29,7 +29,31 @@ export interface Config {
    /**
     * Techdocs generator information
     */
+    generator?: {
+      /**
+       * Where to run the techdocs (mkdocs) generator
+       */
+      runIn: 'local' | 'docker';
+
+      /**
+       * Override the default techdocs docker image
+       */
+      dockerImage?: string;
+
+      /**
+       * Pull the latest docker image
+       */
+      pullImage?: boolean;
+    };
+
+    /**
+     * Techdocs generator information
+     * @deprecated Replaced with techdocs.generator
+     */
    generators?: {
+      /**
+       * @deprecated Use techdocs.generator.runIn
+       */
      techdocs: 'local' | 'docker';
    };