build: add more information to Makefile help

[RedYetiDev]

This PR adds more information to the Makefile by adding more help details to more targets:

make help output

For more targets and info see the comments in the Makefile.

all             Build node in out/Release/node (Default).
bench-addons-build Build required addons for benchmark before running it.
binary          Build release binary tarballs.
build-addons    Build addons for Node.js.
build-ci        Build everything (CI).
build-js-native-api-tests Build JS Native-API tests.
build-node-api-tests Build Node-API tests.
cctest          Run the C++ tests using the built `cctest` executable.
clean           Remove build artifacts.
clear-stalled   Clear any stalled processes.
corepack-update Update Corepack to the latest version.
coverage-build-js Build JavaScript coverage files.
coverage-build  Build coverage files.
coverage-clean  Remove coverage artifacts.
coverage-report-js Report JavaScript coverage results.
coverage-run-js Run JavaScript tests with coverage.
coverage-test   Run the tests and generate a coverage report.
coverage        Run the tests and generate a coverage report.
distclean       Remove all build and test artifacts.
doc             Build Node.js, and then build the documentation with the new binary.
docclean        Remove the generated documentation.
docopen         Open the documentation in a web browser.
docserve        Serve the documentation on localhost:8000.
format-cpp-build Build 'clang-format' tooling for C++ code formatting.
format-cpp-clean Remove 'clang-format' tooling for C++ code formatting.
format-cpp      Format C++ diff from $CLANG_FORMAT_START to current changes.
format-md       Format the markdown documents maintained by us in the codebase.
gen-openssl     Generate platform dependent openssl files (requires docker).
help            Print help for targets with comments.
install         Install node into $PREFIX (default=/usr/local).
jstest          Run addon tests and JS tests.
lint-addon-docs Lint the addon documentation.
lint-clean      Remove linting artifacts.
lint-cpp        Lint the C++ code with cpplint.py and checkimports.py.
lint-js-fix     Lint and fix the JavaScript code with eslint.
lint-md         Lint the markdown documents maintained by us in the codebase.
lint-py-build   Build resources needed to lint python files.
lint-py         Lint the Python code with ruff.
lint-yaml-build Build resources needed to lint YAML files.
lint-yaml       Lint the YAML files with yamllint.
lint            Run JS, C++, MD and doc linters.
list-gtests     List all available C++ gtests.
pkg             Build the macOS installer for releases.
release-only    Prepare Node.js for release.
run-ci          Build and run all tests (CI).
tar-headers     Build the node header tarball.
tar             Create a source tarball.
test-addons-clean Remove addon testing artifacts.
test-addons     Run addon tests.
test-all-suites Run all test suites.
test-all-valgrind Run all tests using valgrind.
test-all        Run default tests with both Debug and Release builds.
test-build-js-native-api Build JS Native-API tests.
test-build-node-api Build Node-API tests.
test-build      Build all tests.
test-ci-js      Build and test JavaScript with building anything else.
test-ci-native  Build and test addons without building anything else.
test-ci         Build and test everything (CI).
test-cov        Run coverage tests.
test-debug      Run tests on a debug build.
test-doc-ci     Build, lint, and verify the docs (CI).
test-doc        Build, lint, and verify the docs.
test-hash-seed  Verifu that the hash seed used by V8 for hashing is random.
test-internet   Run internet tests.
test-js-native-api-clean Remove JS Native-API testing artifacts.
test-js-native-api Run JS Native-API tests.
test-known-issues Run tests for known issues.
test-node-api-clean Remove Node-API testing artifacts.
test-node-api   Run Node-API tests.
test-npm-publish Test the `npm publish` command.
test-npm        Run the npm test suite on deps/npm.
test-only       Run default tests, without linters or building the docs.
test-tick-processor Run tick processor tests.
test-v8-all     Run the entire V8 test suite, including intl, benchmarks, and updates.
test-v8-benchmarks Run the v8 test suite, benchmarks.
test-v8-intl    Run the v8 test suite, intl tests.
test-v8-updates Run the v8 test suite, updates.
test-v8         Run the V8 test suite on deps/v8.
test-valgrind   Run tests using valgrind.
test-with-async-hooks Run tests with async hooks.
test-wpt-report Run the Web Platform Tests and generate a report.
test-wpt        Run the Web Platform Tests.
test            Run default tests, linters, and build docs.
testclean       Remove test artifacts.
tooltest        Test the various tools.
uninstall       Uninstall node from $PREFIX (default=/usr/local).
v8              Build deps/v8.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 87.74%. Comparing base (6dfa3e4) to head (3dd8fe2).
Report is 1 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main   #53381      +/-   ##
==========================================
- Coverage   88.03%   87.74%   -0.29%     
==========================================
  Files         652      652              
  Lines      183765   183765              
  Branches    35858    35521     -337     
==========================================
- Hits       161771   161244     -527     
- Misses      15239    15767     +528     
+ Partials     6755     6754       -1     

see 68 files with indirect coverage changes

[RedYetiDev]

Hey, I don't think this needs-ci as it only changes comments

[tniessen]

±0. In any case, some of the added verbs are in imperative form, some are in third-person singular present tense. I think these should at least be consistent within the same PR.

[nodejs-github-bot]

Commit Queue failed

- Loading data for nodejs/node/pull/53381
✔  Done loading data for nodejs/node/pull/53381
----------------------------------- PR info ------------------------------------
Title      build: add more information to Makefile help (#53381)
Author     Aviv Keller <[email protected]> (@RedYetiDev)
Branch     RedYetiDev:patch-55 -> nodejs:main
Labels     build, needs-ci, commit-queue-squash
Commits    6
 - build: add more information to Makefile help
 - Update Makefile
 - Update Makefile
 - fixup! periods + dependencies
 - reword valgrind tests
 - Merge branch 'main' into patch-55
Committers 2
 - GitHub <[email protected]>
 - RedYetiDev <[email protected]>
PR-URL: https://github.com/nodejs/node/pull/53381
Reviewed-By: Vinícius Lourenço Claro Cardoso <[email protected]>
Reviewed-By: James M Snell <[email protected]>
------------------------------ Generated metadata ------------------------------
PR-URL: https://github.com/nodejs/node/pull/53381
Reviewed-By: Vinícius Lourenço Claro Cardoso <[email protected]>
Reviewed-By: James M Snell <[email protected]>
--------------------------------------------------------------------------------
   ℹ  This PR was created on Fri, 07 Jun 2024 14:37:00 GMT
   ✔  Approvals: 2
   ✔  - Vinícius Lourenço Claro Cardoso (@H4ad): https://github.com/nodejs/node/pull/53381#pullrequestreview-2263230673
   ✔  - James M Snell (@jasnell) (TSC): https://github.com/nodejs/node/pull/53381#pullrequestreview-2263779108
   ✔  Last GitHub CI successful
   ✘  No Jenkins CI runs detected
--------------------------------------------------------------------------------
   ✔  Aborted `git node land` session in /home/runner/work/node/node/.ncu

https://github.com/nodejs/node/actions/runs/10694556571

[nodejs-github-bot]

CI: https://ci.nodejs.org/job/node-test-pull-request/61927/

[RedYetiDev]

CI failed to start, it seems it was due to a merge conflict, I'll rebase main into this PR later today.

[RedYetiDev]

The last CI was only a few days ago, and (surprisingly with the current state of the CI) it passed, is this ready to land?

Nevermind- it failed, I'm starting a new one

[RedYetiDev]

I meant to add request-ci, not feature request, but now that I've pushed commits, can someone with access start a CI?

[aduh95]

Would you like to address #53381 (review) first?

[nodejs-github-bot]

CI: https://ci.nodejs.org/job/node-test-pull-request/62546/