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

doc: prefer make test-only when verifying the build #18061

Closed
wants to merge 1 commit into from
Closed

doc: prefer make test-only when verifying the build #18061

wants to merge 1 commit into from

Conversation

joyeecheung
Copy link
Member

Checklist
  • make -j4 test (UNIX), or vcbuild test (Windows) passes
  • tests and/or benchmarks are included
  • documentation is changed or added
  • commit message follows commit guidelines
Affected core subsystem(s)

doc

@nodejs-github-bot nodejs-github-bot added build Issues and PRs related to build files or the CI. doc Issues and PRs related to the documentations. labels Jan 9, 2018
joyeecheung
joyeecheung commented Jan 9, 2018
View reviewed changes
BUILDING.md
To verify the build:

```console
$ make test-only
Copy link
Member Author

Choose a reason for hiding this comment

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

I am wondering if there is anyone out there using the existing make check (alias to make test) because to me make check sounds better than make test-only for that purpose.

@joyeecheung
Copy link
Member Author

Lite CI: https://ci.nodejs.org/job/node-test-pull-request-lite/78/

@joyeecheung joyeecheung added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Jan 9, 2018
Trott
Trott reviewed Jan 10, 2018
View reviewed changes
BUILDING.md Outdated
$ make test-only
```

At this point you are ready to make code changes and re-run the tests.
Copy link
Member

Choose a reason for hiding this comment

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

Nit: comma after point

Trott
Trott reviewed Jan 10, 2018
View reviewed changes
BUILDING.md Outdated

```console
$ make test
```

At this point you are ready to make code changes and re-run the tests!
Which also runs linters and the tests on the documentation.
Copy link
Member

Choose a reason for hiding this comment

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

Nit: Instead of Which also runs linters... maybe `make test` will run linters...

Copy link
Member Author

@joyeecheung joyeecheung Jan 11, 2018 •
edited
Loading

Choose a reason for hiding this comment

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

I have changed this to

`make test` does a full check on the codebase, including running linters and
documentation tests.

so it's clearer about what it does.

@joyeecheung
Copy link
Member Author

Landed in e8c491a, thanks!

joyeecheung added a commit that referenced this pull request Jan 12, 2018
@joyeecheung
doc: prefer make test-only when verifying the build
e8c491a 
PR-URL: #18061
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Jeremiah Senkpiel <[email protected]>
Reviewed-By: Khaidi Chu <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: Daniel Bevenius <[email protected]>
@TimothyGu TimothyGu removed the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Jan 13, 2018
evanlucas pushed a commit that referenced this pull request Jan 30, 2018
@joyeecheung @evanlucas
doc: prefer make test-only when verifying the build
0e8596e 
PR-URL: #18061
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Jeremiah Senkpiel <[email protected]>
Reviewed-By: Khaidi Chu <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: Daniel Bevenius <[email protected]>
@evanlucas evanlucas mentioned this pull request Jan 30, 2018
Merged
MylesBorins pushed a commit that referenced this pull request Feb 27, 2018
@joyeecheung @MylesBorins
doc: prefer make test-only when verifying the build
98579de 
PR-URL: #18061
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Jeremiah Senkpiel <[email protected]>
Reviewed-By: Khaidi Chu <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: Daniel Bevenius <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Trott Trott Trott left review comments

@XadillaX XadillaX XadillaX approved these changes

@lpinca lpinca lpinca approved these changes

@Fishrock123 Fishrock123 Fishrock123 approved these changes

@jasnell jasnell jasnell approved these changes

@danbev danbev danbev approved these changes

Assignees
No one assigned
Labels
build Issues and PRs related to build files or the CI. doc Issues and PRs related to the documentations.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
10 participants
@joyeecheung @danbev @jasnell @Trott @Fishrock123 @lpinca @XadillaX @MylesBorins @TimothyGu @nodejs-github-bot