Skip to content

CI: add docs audit quality gate and publish audit artifacts #13

@justin808

Description

@justin808

Context

The deploy workflow builds and deploys docs but does not gate on docs quality findings. We already have npm run audit:docs; it should be part of CI.

Relevant workflow: .github/workflows/site-build-deploy.yml

Goal

Add a docs-audit CI step with clear pass/fail rules.

Proposed behavior

  • Run npm run audit:docs in PR checks.
  • Upload the generated report as an artifact.
  • Fail PRs on error-level findings (once severity support lands).
  • Keep advisory findings non-blocking but visible in job summary.

Acceptance criteria

  • Every PR run includes docs audit output.
  • Report artifact is downloadable from Actions.
  • Blocking findings prevent merge.

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