build: add more information to Makefile help
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 Default target, builds node in out/Release/node.
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 for CI
build-js-native-api-tests Builds JS Native-API tests.
build-node-api-tests Builds Node-API tests.
cctest Runs 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 Builds Node.js, and then builds 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 Builds 'clang-format' tooling for C++ code formatting.
format-cpp-clean Removes 'clang-format' tooling for C++ code formatting.
format-cpp Format C++ diff from $CLANG_FORMAT_START to current changes
format-md Formats 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 Installs node into $PREFIX (default=/usr/local).
jstest Runs addon tests and JS tests
lint-addon-docs Lints the addon documentation.
lint-clean Removes linting artifacts.
lint-cpp Lints the C++ code with cpplint.py and checkimports.py.
lint-js-fix Lints and fixes the JavaScript code with eslint.
lint-md Lints the markdown documents maintained by us in the codebase.
lint-py-build Builds resources needed to lint python files.
lint-py Lint the Python code with ruff.
lint-yaml-build Builds resources needed to lint YAML files.
lint-yaml Lints the YAML files with yamllint.
lint Run JS, C++, MD and doc linters.
list-gtests List all available C++ gtests.
pkg Builds the macOS installer for releases.
release-only Prepare Node.js for release.
run-ci Build and run all tests for 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 Test all valgrind tests
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 (in CI)
test-cov Runs coverage tests
test-debug Run tests on a debug build.
test-doc-ci Builds, lints, and verifies the docs for CI.
test-doc Builds, lints, and verifies the docs.
test-hash-seed Verifies 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 For a quick test, does not run linter or build 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 Runs the v8 test suite, benchmarks.
test-v8-intl Runs the v8 test suite, intl tests.
test-v8-updates Runs the v8 test suite, updates.
test-v8 Runs the V8 test suite on deps/v8.
test-valgrind Runs valgrind tests
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 Runs default tests, linters, and builds docs.
testclean Remove test artifacts.
tooltest Tests the various tools.
uninstall Uninstalls node from $PREFIX (default=/usr/local).
v8 Builds deps/v8.
Codecov Report
All modified and coverable lines are covered by tests :white_check_mark:
Project coverage is 87.70%. Comparing base (
2cec716) to head (2897be9). Report is 414 commits behind head on main.
Additional details and impacted files
@@ Coverage Diff @@
## main #53381 +/- ##
==========================================
- Coverage 88.23% 87.70% -0.53%
==========================================
Files 652 652
Lines 183911 183911
Branches 35858 35562 -296
==========================================
- Hits 162271 161298 -973
- Misses 14916 15853 +937
- Partials 6724 6760 +36
Hey, I don't think this needs-ci as it only changes comments
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/.ncuhttps://github.com/nodejs/node/actions/runs/10694556571
CI: https://ci.nodejs.org/job/node-test-pull-request/61927/
CI failed to start, it seems it was due to a merge conflict, I'll rebase main into this PR later today.
~~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
I meant to add request-ci, not feature request, but now that I've pushed commits, can someone with access start a CI?
Would you like to address https://github.com/nodejs/node/pull/53381#pullrequestreview-2263799322 first?
CI: https://ci.nodejs.org/job/node-test-pull-request/62546/
CI: https://ci.nodejs.org/job/node-test-pull-request/62633/
Looks like the most recent CI failed to start
CI: https://ci.nodejs.org/job/node-test-pull-request/62703/
CI is 🟢 / 🟠 (1 flake)
CI: https://ci.nodejs.org/job/node-test-pull-request/62734/
CI is 🟢 (yay!)
Landed in b2c42dbcbb1f581cc4539cb10cdc3d5254dee8b2