You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+5-2Lines changed: 5 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -65,7 +65,8 @@ The default output is suitable for passing to `firebase deploy --only` command.
65
65
| sep || Separator for each output function |`,`|
66
66
| bundlerConfig || Path to the bundler config file which would be passed to esbuild ||
67
67
| concurrency || Number to control the concurrency of the bundling process. Useful in CI/CD flows with limited memory | Number of functions in .differspec.json |
68
-
| discover || (**Experimental**) Flag indicating whether to use automatic function path discovery | false |
68
+
| discover || (**Experimental**) Flag indicating whether to use automatic function path discovery | true |
69
+
| no-discover || (**Experimental**) Negates the `--discover` flag ||
69
70
| indexFilePath || (**Experimental**) Location of the index.ts file which exports all the functions. Optional. Only used if used with `--discover`|`src/index.ts`|
70
71
71
72
## .differspec.json
@@ -78,7 +79,6 @@ The default output is suitable for passing to `firebase deploy --only` command.
78
79
|`hashes`| (**AUTOGENERATED, DO NOT MODIFY**) JSON object containing hashes of all functions in the `functions` property |
79
80
|`lastDiff`| (**AUTOGENERATED, DO NOT MODIFY**) JSON object containing the results of the last successful invocation of `functions-differ`|
80
81
81
-
- The `functions` property serves as an index of all functions present in your repository. `functions-differ` does not support automatic discovery of functions in the project (yet), and therefore this property is required.
82
82
- The `hashes` and `lastDiff` properties are autogenerated by `functions-differ`, and should not be created/edited manually.
83
83
84
84
## Contributions
@@ -114,3 +114,6 @@ Here are some ways to do that for GitHub Actions:
114
114
115
115
1. Use [caching](https://docs.github.com/en/actions/using-workflows/caching-dependencies-to-speed-up-workflows) between CI runs for the `.differspec.json` file.
116
116
2. Read/store the contents of the `.differspec.json` file in GitHub secrets in each CI run using the `gh` CLI available to every job.
117
+
118
+
This tool uses ESBuild internally to bundle Cloud Functions in parallel. Bundling is a resource intensive process.
119
+
If your CI builds appear to crash or run very slowly after integrating functions-differ, it could be due to high memory usage by ESBuild. Consider using the `--concurrency` option to control how many Cloud Functions to bundle in parallel.
0 commit comments