Skip to content

Commit d077bbc

Browse files
committed
feat: Update docs and bump version number
1 parent 0a40e95 commit d077bbc

File tree

3 files changed

+8
-5
lines changed

3 files changed

+8
-5
lines changed

README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,8 @@ The default output is suitable for passing to `firebase deploy --only` command.
6565
| sep | | Separator for each output function | `,` |
6666
| bundlerConfig | | Path to the bundler config file which would be passed to esbuild | |
6767
| 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 | |
6970
| indexFilePath | | (**Experimental**) Location of the index.ts file which exports all the functions. Optional. Only used if used with `--discover` | `src/index.ts` |
7071

7172
## .differspec.json
@@ -78,7 +79,6 @@ The default output is suitable for passing to `firebase deploy --only` command.
7879
| `hashes` | (**AUTOGENERATED, DO NOT MODIFY**) JSON object containing hashes of all functions in the `functions` property |
7980
| `lastDiff` | (**AUTOGENERATED, DO NOT MODIFY**) JSON object containing the results of the last successful invocation of `functions-differ` |
8081

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.
8282
- The `hashes` and `lastDiff` properties are autogenerated by `functions-differ`, and should not be created/edited manually.
8383

8484
## Contributions
@@ -114,3 +114,6 @@ Here are some ways to do that for GitHub Actions:
114114

115115
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.
116116
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.

package-lock.json

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "functions-differ",
3-
"version": "0.3.0",
3+
"version": "0.3.1",
44
"description": "Deploy only the Firebase Functions that changed",
55
"homepage": "https://github.com/haroldadmin/functions-differ",
66
"repository": "https://github.com/haroldadmin/functions-differ",

0 commit comments

Comments
 (0)