From f157893858149d1c2d1ac1f760f4d0d853333bab Mon Sep 17 00:00:00 2001 From: Marco Ippolito Date: Mon, 3 Apr 2023 10:50:40 +0200 Subject: [PATCH] doc: create maintaining-brotli.md PR-URL: https://github.com/nodejs/node/pull/47380 Refs: https://github.com/nodejs/security-wg/issues/828 Reviewed-By: Yagiz Nizipli Reviewed-By: Paolo Insogna Reviewed-By: Rafael Gonzaga Reviewed-By: Luigi Pinca --- doc/contributing/maintaining-brotli.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) create mode 100644 doc/contributing/maintaining-brotli.md diff --git a/doc/contributing/maintaining-brotli.md b/doc/contributing/maintaining-brotli.md new file mode 100644 index 00000000000000..e8b0ddbe97e3c0 --- /dev/null +++ b/doc/contributing/maintaining-brotli.md @@ -0,0 +1,26 @@ +# Maintaining brotli + +The [brotli](https://github.com/google/brotli) dependency is used for +the homonym generic-purpose lossless compression algorithm. + +## Updating brotli + +The `tools/dep_updaters/update-brotli.sh` script automates the update of the +brotli source files. + +Check that Node.js still builds and tests. + +## Committing postject + +1. Add brotli: + ```console + $ git add deps/brotli + ``` +2. Commit the changes: `git commit`. +3. Add a message like: + + ```text + deps,test: update brotli to + + Updated as described in doc/contributing/maintaining-brotli.md. + ```