镜像站点 · 本页由第三方 GitHub 只读镜像提供,非 GitHub 官方站点,不接受任何登录或凭据输入。前往 github.com
Skip to content

node-test-commit: run make doc during tests #887

Closed

Description

@maclover7

Running make doc (and making sure the exit status is 0) can help with nodejs/node#15447. I think the chances a YAML error would be introduced are low, but it would be great to catch this via CI as an early warning system, and not via checking the nightly doc builds :)

cc @refack @vsemozhetbyt

Activity

  1. vsemozhetbyt commented on Sep 17, 2017

    @vsemozhetbyt

    Refs: nodejs/node#14930 (2 cases)

  2. refack commented on Sep 17, 2017

    @refack
    Contributor

    @maclover7 thanks for following up on this.

    1. IMHO this should be done in code, as a test in /test/sequential so that we could not only check sanity, but also validate properties of the resulted docs.
    2. Meanwhile I see no harm in adding make doc-only to node-test-linter
  3. maclover7 commented on Oct 6, 2017

    @maclover7
    ContributorAuthor

    Looks like this happened again (see nodejs/node#14930 (comment) for details). Personally, I still think compiling docs via node-test-commit (or node-test-linter) is the best solution. I see @gibfahn and @mhdawson gave a +1 to @refack's comment above... what's the best way to move forward here?

  4. gibfahn commented on Oct 6, 2017

    @gibfahn
    Member

    what's the best way to move forward here?

    So assuming we're doing this:

    IMHO this should be done in code, as a test in /test/sequential so that we could not only check sanity, but also validate properties of the resulted docs.

    that would just be a PR to nodejs/node that added a test in test/sequential/ that runs make doc and verifies that things work okay.

  5. added a commit that references this issue on Oct 18, 2017
  6. added a commit that references this issue on Jul 27, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions