Skip to content

build: build docs on Travis #29783

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
Closed
richardlau wants to merge 1 commit into from
Closed

build: build docs on Travis #29783

richardlau wants to merge 1 commit into from

Conversation

@richardlau
Copy link
Member

@richardlau richardlau commented Sep 30, 2019 •
edited
Loading

Build the docs on Travis. This is a prerequisite for #29770.

Checklist
  • make -j4 test (UNIX), or vcbuild test (Windows) passes
  • commit message follows commit guidelines

@nodejs-github-bot nodejs-github-bot added the build Issues and PRs related to build files or the CI. label Sep 30, 2019
@richardlau richardlau added the wip Issues and PRs that are still a work in progress. label Sep 30, 2019
@richardlau

This comment has been minimized.

Sign in to view
@richardlau richardlau changed the title build: build and test docs on Travis build: build docs on Travis Sep 30, 2019
@richardlau
Copy link
Member Author

richardlau commented Sep 30, 2019 •
edited
Loading

The test-doc make target runs:

  • the doc-only target to build the docs (our Travis builds weren't doing this)
  • lint target (our Travis builds already does this)
  • runs the doctool tests (our Travis builds weren't doing this)

It looks like the doctool tests test the code to generate the docs -- I'd consider such code to not be a "doc-only" change and am thus arguing we don't need to run doctool tests on Travis.

This PR adds the doc-only target so that the docs are built as well as linted.

node/Makefile

Lines 601 to 608 in 2487f39

.PHONY: test-doc
test-doc: doc-only ## Builds, lints, and verifies the docs.
@if [ "$(shell $(node_use_openssl))" != "true" ]; then \
echo "Skipping test-doc (no crypto)"; \
else \
$(MAKE) lint; \
$(PYTHON) tools/test.py $(PARALLEL_ARGS) doctool; \
fi

@richardlau richardlau removed the wip Issues and PRs that are still a work in progress. label Sep 30, 2019
@Trott Trott added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Oct 3, 2019
@Trott
Copy link
Member

Trott commented Oct 3, 2019

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

Trott pushed a commit that referenced this pull request Oct 3, 2019
@richardlau @Trott
build: build docs on Travis
b5e40ba 
PR-URL: #29783
Reviewed-By: Ruben Bridgewater <[email protected]>
Reviewed-By: Rich Trott <[email protected]>
Reviewed-By: Trivikram Kamat <[email protected]>
@Trott
Copy link
Member

Trott commented Oct 3, 2019

Landed in b5e40ba

@Trott Trott closed this Oct 3, 2019
BridgeAR pushed a commit that referenced this pull request Oct 9, 2019
@richardlau @BridgeAR
build: build docs on Travis
d09f2b4 
PR-URL: #29783
Reviewed-By: Ruben Bridgewater <[email protected]>
Reviewed-By: Rich Trott <[email protected]>
Reviewed-By: Trivikram Kamat <[email protected]>
@richardlau richardlau mentioned this pull request Oct 9, 2019
Closed
@BridgeAR BridgeAR mentioned this pull request Oct 10, 2019
Merged
@richardlau richardlau mentioned this pull request Dec 16, 2019
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@Trott Trott Trott approved these changes

@BridgeAR BridgeAR BridgeAR approved these changes

@trivikr trivikr trivikr approved these changes

Assignees

No one assigned

Labels

author ready PRs that have at least one approval, no pending requests for changes, and a CI started. build Issues and PRs related to build files or the CI.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@richardlau @Trott @BridgeAR @trivikr @nodejs-github-bot