Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

build: add more information to Makefile help #53381

Merged
merged 1 commit into from
Sep 24, 2024
Merged

build: add more information to Makefile help #53381

merged 1 commit into from
Sep 24, 2024

Conversation

RedYetiDev
Copy link
Member

@RedYetiDev RedYetiDev commented Jun 7, 2024 •
edited
Loading

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.

@nodejs-github-bot nodejs-github-bot added build Issues and PRs related to build files or the CI. needs-ci PRs that need a full CI run. labels Jun 7, 2024
@H4ad H4ad added the commit-queue-squash Add this label to instruct the Commit Queue to squash all the PR commits into the first one. label Jun 9, 2024
aduh95
aduh95 reviewed Jun 13, 2024
View reviewed changes
Makefile Outdated Show resolved Hide resolved
aduh95
aduh95 reviewed Jun 13, 2024
View reviewed changes
Makefile Outdated Show resolved Hide resolved
@RedYetiDev RedYetiDev requested a review from aduh95 June 13, 2024 14:17
tniessen
tniessen reviewed Jun 13, 2024
View reviewed changes
Makefile Outdated Show resolved Hide resolved
@codecov Codecov
Copy link

codecov bot commented Aug 26, 2024 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

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

see 90 files with indirect coverage changes

@RedYetiDev
Copy link
Member Author

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

tniessen
tniessen reviewed Aug 27, 2024
View reviewed changes
Copy link
Member

@tniessen tniessen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

±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.

@H4ad H4ad added the commit-queue Add this label to land a pull request using GitHub Actions. label Sep 4, 2024
@nodejs-github-bot nodejs-github-bot added commit-queue-failed An error occurred while landing this pull request using GitHub Actions. and removed commit-queue Add this label to land a pull request using GitHub Actions. labels Sep 4, 2024
@nodejs-github-bot
Copy link
Collaborator

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 <redyetidev@gmail.com> (@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 <noreply@github.com>
 - RedYetiDev <38299977+RedYetiDev@users.noreply.github.com>
PR-URL: https://github.com/nodejs/node/pull/53381
Reviewed-By: Vinícius Lourenço Claro Cardoso <contact@viniciusl.com.br>
Reviewed-By: James M Snell <jasnell@gmail.com>
------------------------------ Generated metadata ------------------------------
PR-URL: https://github.com/nodejs/node/pull/53381
Reviewed-By: Vinícius Lourenço Claro Cardoso <contact@viniciusl.com.br>
Reviewed-By: James M Snell <jasnell@gmail.com>
--------------------------------------------------------------------------------
   ℹ  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

@H4ad H4ad added request-ci Add this label to start a Jenkins CI on a PR. and removed commit-queue-failed An error occurred while landing this pull request using GitHub Actions. labels Sep 4, 2024
@github-actions github-actions bot removed the request-ci Add this label to start a Jenkins CI on a PR. label Sep 4, 2024
@nodejs-github-bot
Copy link
Collaborator

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

@RedYetiDev
Copy link
Member Author

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

@RedYetiDev
Copy link
Member Author

RedYetiDev commented Sep 10, 2024 •
edited
Loading

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 RedYetiDev added the feature request Issues that request new features to be added to Node.js. label Sep 10, 2024
@RedYetiDev RedYetiDev removed the feature request Issues that request new features to be added to Node.js. label Sep 17, 2024
@RedYetiDev
Copy link
Member Author

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

@aduh95 aduh95 added author ready PRs that have at least one approval, no pending requests for changes, and a CI started. request-ci Add this label to start a Jenkins CI on a PR. labels Sep 19, 2024
@github-actions github-actions bot removed the request-ci Add this label to start a Jenkins CI on a PR. label Sep 19, 2024
@nodejs-github-bot

This comment was marked as outdated.

Sign in to view
@nodejs-github-bot
Copy link
Collaborator

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

@RedYetiDev
Copy link
Member Author

Looks like the most recent CI failed to start

@H4ad H4ad added the request-ci Add this label to start a Jenkins CI on a PR. label Sep 23, 2024
@github-actions github-actions bot removed the request-ci Add this label to start a Jenkins CI on a PR. label Sep 23, 2024
@nodejs-github-bot
Copy link
Collaborator

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

@RedYetiDev
Copy link
Member Author

RedYetiDev commented Sep 24, 2024 •
edited
Loading

CI is 🟢 / 🟠 (1 flake)

@nodejs-github-bot
Copy link
Collaborator

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

@RedYetiDev
Copy link
Member Author

CI is 🟢 (yay!)

@aduh95 aduh95 added the commit-queue Add this label to land a pull request using GitHub Actions. label Sep 24, 2024
@nodejs-github-bot nodejs-github-bot removed the commit-queue Add this label to land a pull request using GitHub Actions. label Sep 24, 2024
@nodejs-github-bot nodejs-github-bot merged commit b2c42db into nodejs:main Sep 24, 2024
54 checks passed
@nodejs-github-bot
Copy link
Collaborator

Landed in b2c42db

targos pushed a commit that referenced this pull request Oct 4, 2024
@RedYetiDev @targos
build: add more information to Makefile help
68822cc 
PR-URL: #53381
Reviewed-By: Vinícius Lourenço Claro Cardoso <contact@viniciusl.com.br>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
@aduh95 aduh95 mentioned this pull request Oct 9, 2024
Merged
louwers pushed a commit to louwers/node that referenced this pull request Nov 2, 2024
@RedYetiDev @louwers
build: add more information to Makefile help
419adc7 
PR-URL: nodejs#53381
Reviewed-By: Vinícius Lourenço Claro Cardoso <contact@viniciusl.com.br>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
@marco-ippolito marco-ippolito added the backport-requested-v20.x PRs awaiting manual backport to the v20.x-staging branch. label Nov 16, 2024
tpoisseau pushed a commit to tpoisseau/node that referenced this pull request Nov 21, 2024
@RedYetiDev @tpoisseau
build: add more information to Makefile help
e02302d 
PR-URL: nodejs#53381
Reviewed-By: Vinícius Lourenço Claro Cardoso <contact@viniciusl.com.br>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@richardlau richardlau richardlau left review comments

@targos targos targos left review comments

@aduh95 aduh95 aduh95 approved these changes

@H4ad H4ad H4ad approved these changes

@jasnell jasnell jasnell approved these changes

@tniessen tniessen Awaiting requested review from tniessen

Assignees
No one assigned
Labels
author ready PRs that have at least one approval, no pending requests for changes, and a CI started. backport-requested-v20.x PRs awaiting manual backport to the v20.x-staging branch. build Issues and PRs related to build files or the CI. commit-queue-squash Add this label to instruct the Commit Queue to squash all the PR commits into the first one. needs-ci PRs that need a full CI run.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
9 participants
@RedYetiDev @nodejs-github-bot @aduh95 @jasnell @targos @tniessen @richardlau @H4ad @marco-ippolito