Skip to content

chore: check if docs updates are required

Kai Armstrong requested to merge phikai-automatic-doc-generation into main

Description

This adds a new CI job that runs the documentation generation command on the cloned project. The command then checks to see if anything would be added via git add -A --dry-run. If that command returns any results, then there are documentation changes and the CI job fails and provides the link to generate the docs.

Related Issues

Resolves #1002 (closed)

How has this been tested?

You can see this working in pipeline runs in this MR:

  1. Failed job where documentation changes were required
  2. Passing job where NO documentation changes were required

Screenshots (if appropriate):

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation
  • Chore (Related to CI or Packaging to platforms)
Edited by Kai Armstrong

Merge request reports