From 06c29aca2e7efeb2d58ca5d10a7c6c02abe76b89 Mon Sep 17 00:00:00 2001 From: Mike McCready <66998419+MikeMcC399@users.noreply.github.com> Date: Tue, 21 Jan 2025 09:41:51 +0100 Subject: [PATCH 1/2] docs: add DEBUG=corepack logging instructions --- CONTRIBUTING.md | 3 ++- README.md | 2 ++ 2 files changed, 4 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 99d5f0217..ed3c7e3ed 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -9,7 +9,8 @@ If you want to build Corepack yourself, you can build the project like this: The `dist/` directory now contains the corepack build and the shims. Call `node ./dist/corepack --help` and behold. -You can also run the tests with `yarn test`. + +You can also run the tests with `yarn test`. (Do not set the environment variable `DEBUG=corepack` when running tests. The additional debug logging causes tests to fail.) # Adding a new package manager diff --git a/README.md b/README.md index d94614aff..66bfbc3fb 100644 --- a/README.md +++ b/README.md @@ -302,6 +302,8 @@ same major line. Should you need to upgrade to a new major, use an explicit ## Troubleshooting +The environment variable `DEBUG` can be set to `corepack` to enable additional debug logging. + ### Networking There are a wide variety of networking issues that can occur while running From cf904483eb4c9396f5300758819b6e04ce7f7ae1 Mon Sep 17 00:00:00 2001 From: Mike McCready <66998419+MikeMcC399@users.noreply.github.com> Date: Tue, 21 Jan 2025 13:08:26 +0100 Subject: [PATCH 2/2] Revert change to CONTRIBUTING.md --- CONTRIBUTING.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ed3c7e3ed..99d5f0217 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -9,8 +9,7 @@ If you want to build Corepack yourself, you can build the project like this: The `dist/` directory now contains the corepack build and the shims. Call `node ./dist/corepack --help` and behold. - -You can also run the tests with `yarn test`. (Do not set the environment variable `DEBUG=corepack` when running tests. The additional debug logging causes tests to fail.) +You can also run the tests with `yarn test`. # Adding a new package manager