Gecko [ unitednationsplay.com ]

Name	Size	Permission	Date
contributing	[ DIR ]	drwxr-xr-x	2022-01-26 16:43
doc_img	[ DIR ]	drwxr-xr-x	2022-01-26 16:43
adding-new-napi-api.md	2.55 KB	-rw-r--r--	2022-01-10 13:06
backporting-to-release-lines.md	4.38 KB	-rw-r--r--	2022-01-10 13:06
building-node-with-ninja.md	1.42 KB	-rw-r--r--	2022-01-10 13:06
collaborator-guide.md	40.27 KB	-rw-r--r--	2022-01-10 13:06
commit-queue.md	5.4 KB	-rw-r--r--	2022-01-10 13:06
cpp-style-guide.md	12.79 KB	-rw-r--r--	2022-01-10 13:06
diagnostic-tooling-support-tiers.md	8.66 KB	-rw-r--r--	2022-01-10 13:06
doc-style-guide.md	5.72 KB	-rw-r--r--	2022-01-10 13:06
internal-api.md	539 B	-rw-r--r--	2022-01-10 13:06
investigating_native_memory_leak.md	26.95 KB	-rw-r--r--	2022-01-10 13:06
maintaining-V8.md	17.66 KB	-rw-r--r--	2022-01-10 13:06
maintaining-c-ares.md	1.63 KB	-rw-r--r--	2022-01-10 13:06
maintaining-icu.md	8.27 KB	-rw-r--r--	2022-01-10 13:06
maintaining-npm.md	1.2 KB	-rw-r--r--	2022-01-10 13:06
maintaining-openssl.md	3.82 KB	-rw-r--r--	2022-01-10 13:06
maintaining-root-certs.md	3.57 KB	-rw-r--r--	2022-01-10 13:06
maintaining-the-build-files.md	2.39 KB	-rw-r--r--	2022-01-10 13:06
maintaining-zlib.md	892 B	-rw-r--r--	2022-01-10 13:06
node-postmortem-support.md	2.53 KB	-rw-r--r--	2022-01-10 13:06
offboarding.md	727 B	-rw-r--r--	2022-01-10 13:06
releases.md	34.1 KB	-rw-r--r--	2022-01-10 13:06
security-release-process.md	5.99 KB	-rw-r--r--	2022-01-10 13:06
strategic-initiatives.md	2.93 KB	-rw-r--r--	2022-01-10 13:06
technical-values.md	2.77 KB	-rw-r--r--	2022-01-10 13:06
using-internal-errors.md	4.9 KB	-rw-r--r--	2022-01-10 13:06
using-symbols.md	2.31 KB	-rw-r--r--	2022-01-10 13:06
writing-and-running-benchmarks.md	22.76 KB	-rw-r--r--	2022-01-10 13:06
writing-tests.md	15.83 KB	-rw-r--r--	2022-01-10 13:06

Rename

# Maintaining c-ares

Updates to the c-ares dependency involve the following steps:

1. Downloading the source archive for the new version.
2. Unpacking the source in a temporary workspace directory.
3. Removing the `test` directory (to save disk space).
4. Copying over the existing `.gitignore`, pre-generated `config` directory and
   `cares.gyp` files.
5. Replacing the existing `deps/cares` with the workspace directory.
6. Modifying the `cares.gyp` file for file additions/deletions.
7. Rebuilding the main Node.js `LICENSE`.

## Running the update script

The `tools/update-cares.sh` script automates the update of the c-ares source
files, preserving the existing files added by Node.js.

In the following examples, `x.y.z` should match the c-ares version to update to.

```console
./tools/update-cares.sh x.y.z
```

e.g.

```console
./tools/update-cares.sh 1.18.1
```

## Check that Node.js still builds and tests

It may be necessary to update `deps/cares/cares.gyp` if any significant changes
have occurred upstream.

## Rebuild the main Node.js license

Run the `tools/license-builder.sh` script to rebuild the main Node.js `LICENSE`
file. This may result in no changes if c-ares' license has not changed.

```console
./tools/license-builder.sh
```

If the updated `LICENSE` contains changes for other dependencies, those should
be done in a separate pull request first.

## Commit the changes

```console
git add -A deps/cares
```

Add the rebuilt `LICENSE` if it has been updated.

```console
git add LICENSE
```

Commit the changes with a message like

```text
deps: update c-ares to x.y.z

Updated as described in doc/guides/maintaining-c-ares.md.
```