Skip to content

Include docs build in PR build verification#741

Open
anjbur wants to merge 3 commits into
NVIDIA:mainfrom
anjbur:fix-pr-gate
Open

Include docs build in PR build verification#741
anjbur wants to merge 3 commits into
NVIDIA:mainfrom
anjbur:fix-pr-gate

Conversation

@anjbur

@anjbur anjbur commented Jul 22, 2026

Copy link
Copy Markdown
Collaborator

Description

Currently, the PR CI workflow does not include the docs build in the verification step. This adds docs to that gate.

Runtime / performance impact

Self-review checklist

Please confirm each item before requesting review. Check [x] or strike
through and explain.

Before requesting review

  • I reviewed my own full diff in GitHub or my editor.
  • PR is in Draft if it is not yet ready for review.
  • Temporary / debugging changes have been removed.
  • Local test logs reviewed; no unexplained warnings or errors.
  • CI logs reviewed; no unexplained warnings or errors.
  • Full CI has been run.

Scope and size

  • PR is under ~1000 lines, or an exception is justified in the description.
  • Refactoring-only changes are isolated in their own PR(s).
  • No existing tests were disabled or modified just to make this PR pass
    (if so, an issue has been raised).

Tests

  • New functionality has new tests.
  • Tests fail if the new functionality is broken (including crashes), not
    just when it is missing.
  • Negative tests added where exceptions are expected.
  • Truth data added where simple EXPECT_* / assert checks are
    insufficient for algorithmic correctness.
  • CI runtime impact considered; team notified if significant.

Documentation

  • Public-facing APIs have Doxygen docs.
  • User-visible behavior changes have public docs, or a follow-up is
    tracked.

Code style

  • Naming follows the existing convention (snake_case vs camelCase) for
    the area being modified.

Dependencies

  • No new third-party dependencies, or the team has been notified and
    OSRB tickets filed.

Signed-off-by: Angela Burton <angelab@nvidia.com>
@anjbur
anjbur marked this pull request as ready for review July 22, 2026 20:59
@anjbur
anjbur requested a review from bmhowe23 July 22, 2026 20:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants