Commit 537c17e
doc: create maintaining-brotli.md
PR-URL: #47380
Refs: nodejs/security-wg#828
Reviewed-By: Yagiz Nizipli <yagiz@nizipli.com>
Reviewed-By: Paolo Insogna <paolo@cowtech.it>
Reviewed-By: Rafael Gonzaga <rafael.nunu@hotmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>1 parent cda36bf commit 537c17e
1 file changed
Lines changed: 26 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -0,0 +1,26 @@ | |||
| 1 | + # Maintaining brotli | ||
| 2 | + | ||
| 3 | + The [brotli](https://github.com/google/brotli) dependency is used for | ||
| 4 | + the homonym generic-purpose lossless compression algorithm. | ||
| 5 | + | ||
| 6 | + ## Updating brotli | ||
| 7 | + | ||
| 8 | + The `tools/dep_updaters/update-brotli.sh` script automates the update of the | ||
| 9 | + brotli source files. | ||
| 10 | + | ||
| 11 | + Check that Node.js still builds and tests. | ||
| 12 | + | ||
| 13 | + ## Committing postject | ||
| 14 | + | ||
| 15 | + 1. Add brotli: | ||
| 16 | + ```console | ||
| 17 | + $ git add deps/brotli | ||
| 18 | + ``` | ||
| 19 | + 2. Commit the changes: `git commit`. | ||
| 20 | + 3. Add a message like: | ||
| 21 | + | ||
| 22 | + ```text | ||
| 23 | + deps,test: update brotli to <version> | ||
| 24 | + | ||
| 25 | + Updated as described in doc/contributing/maintaining-brotli.md. | ||
| 26 | + ``` | ||
0 commit comments