Generate local gitignore when using public workflow manifests (#1683)

Co-authored-by: Peter Wielander <peter.wielander@vercel.com>
Co-authored-by: Peter Wielander <mittgfu@gmail.com>

Author: pranaygp

.changeset/ignore-generated-manifest.md

@@ -0,0 +1,7 @@
+---
+"@workflow/builders": patch
+"@workflow/next": patch
+"@workflow/sveltekit": patch
+---
+
+Write colocated `.gitignore` files for public workflow manifests generated by `WORKFLOW_PUBLIC_MANIFEST=1`

packages/builders/src/vercel-build-output-api.ts

@@ -62,6 +62,9 @@ export class VercelBuildOutputAPIBuilder extends BaseBuilder {
         'static/.well-known/workflow/v1'
       );
       await mkdir(staticManifestDir, { recursive: true });
+      if (process.env.VERCEL_DEPLOYMENT_ID === undefined) {
+        await writeFile(join(staticManifestDir, '.gitignore'), '*');
+      }
       await copyFile(
         join(workflowGeneratedDir, 'manifest.json'),
         join(staticManifestDir, 'manifest.json')

packages/next/src/builder-deferred.ts

@@ -589,6 +589,12 @@ export async function getNextBuilderDeferred() {
           'public/.well-known/workflow/v1'
         );
         await mkdir(publicManifestDir, { recursive: true });
+        if (process.env.VERCEL_DEPLOYMENT_ID === undefined) {
+          await this.writeFileIfChanged(
+            join(publicManifestDir, '.gitignore'),
+            '*'
+          );
+        }
         await this.copyFileIfChanged(
           manifestFilePath,
           join(publicManifestDir, 'manifest.json')

packages/next/src/builder-eager.ts

@@ -79,6 +79,9 @@ export async function getNextBuilderEager() {
             'public/.well-known/workflow/v1'
           );
           await mkdir(publicManifestDir, { recursive: true });
+          if (process.env.VERCEL_DEPLOYMENT_ID === undefined) {
+            await writeFile(join(publicManifestDir, '.gitignore'), '*');
+          }
           await copyFile(
             join(workflowGeneratedDir, 'manifest.json'),
             join(publicManifestDir, 'manifest.json')

packages/sveltekit/src/builder.ts

@@ -109,6 +109,9 @@ export const POST = async ({request}) => {
         'static/.well-known/workflow/v1'
       );
       await mkdir(staticManifestDir, { recursive: true });
+      if (process.env.VERCEL_DEPLOYMENT_ID === undefined) {
+        await writeFile(join(staticManifestDir, '.gitignore'), '*');
+      }
       await copyFile(
         join(workflowGeneratedDir, 'manifest.json'),
         join(staticManifestDir, 'manifest.json')

workbench/example/.gitignore

@@ -1 +1 @@
-manifest.js
+manifest.js