Skip to content

[Enhancement]: Add Code Quality Check to Ensure Docs are Generated #553

@JSCRUDAT0

Description

@JSCRUDAT0

Description of Enhancement :

Discovered a recent PR #545 did not include updated docs. This is probably not the first time we've had schemas updated without corresponding doc updates. We should include an action that tests if running npm run docs:generate changes the docs directory, and, if so, fail the PR. I need to see if there might be OK reasons for this to happen - e.g. date stamps change - but I think this will be an effective way to prevent this in the future.

Why is this Needed?

It should not be possible to pass checks if updated docs are missing.

Anything else we need to know?

See discussion in PR #552

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions