Skip to content

Commit

Permalink
feat: Update docs and bump version number
Browse files Browse the repository at this point in the history
  • Loading branch information
haroldadmin committed Jul 9, 2022
1 parent 0a40e95 commit d077bbc
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 5 deletions.
7 changes: 5 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,8 @@ The default output is suitable for passing to `firebase deploy --only` command.
| sep | | Separator for each output function | `,` |
| bundlerConfig | | Path to the bundler config file which would be passed to esbuild | |
| concurrency | | Number to control the concurrency of the bundling process. Useful in CI/CD flows with limited memory | Number of functions in .differspec.json |
| discover | | (**Experimental**) Flag indicating whether to use automatic function path discovery | false |
| discover | | (**Experimental**) Flag indicating whether to use automatic function path discovery | true |
| no-discover | | (**Experimental**) Negates the `--discover` flag | |
| indexFilePath | | (**Experimental**) Location of the index.ts file which exports all the functions. Optional. Only used if used with `--discover` | `src/index.ts` |

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

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

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

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

This tool uses ESBuild internally to bundle Cloud Functions in parallel. Bundling is a resource intensive process.
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.
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "functions-differ",
"version": "0.3.0",
"version": "0.3.1",
"description": "Deploy only the Firebase Functions that changed",
"homepage": "https://github.com/haroldadmin/functions-differ",
"repository": "https://github.com/haroldadmin/functions-differ",
Expand Down

0 comments on commit d077bbc

Please sign in to comment.