feat: deprecate Docker bundler

The docker bundler will be remove in v2. Usage of it is deprecated and you should use `BundlerPriority.LocalOnly` to be prepared.
mrgrain · Oct 17, 2021 · 6715463 · 6715463
1 parent 0ddb6d0
commit 6715463
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 1 deletion.
diff --git a/lib/asset.ts b/lib/asset.ts
@@ -18,6 +18,7 @@ export interface EsbuildAssetProps extends Partial<IAsset> {
    * Priority order of available bundlers. Defaults to attempt local first, then docker.
    *
    * @default BundlerPriority.AttemptLocal
+   * @deprecated "Docker support will be removed in v2. Set to `BundlerPriority.LocalOnly` to be prepared."
    */
   bundlerPriority?: BundlerPriority;
 
@@ -75,7 +76,7 @@ abstract class Asset<Props extends EsbuildAssetProps> extends S3Asset {
         {
           priority: bundlerPriority,
           copyDir,
-        }
+        },
       ),
     });
   }

diff --git a/lib/bundlers.ts b/lib/bundlers.ts
@@ -16,6 +16,7 @@ export type BuildOptions = MarkRequired<EsbuildOptions, "entryPoints">;
 export enum BundlerPriority {
   /**
    * Only use the Docker bundler
+   * @deprecated "Docker support will be removed in v2. Set to `BundlerPriority.LocalOnly` to be prepared."
    */
   DockerOnly,
 
@@ -26,6 +27,7 @@ export enum BundlerPriority {
 
   /**
    * Attempts to first use the local bundler, only use Docker bundler if local fails.
+   * @deprecated "Docker support will be removed in v2. Set to `BundlerPriority.LocalOnly` to be prepared."
    */
   AttemptLocal,
 }
@@ -48,6 +50,7 @@ export interface BundlerProps {
    * Priority order of available bundlers. Defaults to attempt local first, then docker.
    *
    * @default BundlerPriority.AttemptLocal
+   * @deprecated "Docker support will be removed in v2. Set to `BundlerPriority.LocalOnly` to be prepared."
    */
   priority?: BundlerPriority;
 }