Skip to content

Validate UML artifacts in PRs instead of pushing to protected master - #103

Merged
fuhrmanator merged 12 commits into
masterfrom
copilot/generate-uml-failure-resolution
Sep 20, 2026
Merged

fuhrmanator merged 12 commits into
masterfrom
copilot/generate-uml-failure-resolution

Conversation

Copilot AI commented Sep 11, 2026

Copy link
Copy Markdown
Contributor

The generate-uml workflow was failing because it attempted to push regenerated UML files directly to protected master. This updates the workflow to treat UML artifacts as checked-in outputs that must be refreshed in the PR branch.

  • CI behavior

    • Run the UML workflow on pull requests targeting master
    • Generate doc-uml/ artifacts during CI
    • Fail the job when generated UML differs from the committed files, instead of attempting a direct push to the protected branch
  • Contributor workflow

    • Document in README.md that changes under src/lib/famix/ may require committed updates to doc-uml/
    • Add the expected local update flow so contributors can refresh UML before updating the PR
  • Failure guidance

    • Replace the branch-protection push failure with an explicit message telling contributors to regenerate and commit UML artifacts
- name: Fail if UML diagrams are outdated
  if: steps.check_changes.outputs.changed == 'true'
  run: |
    echo "Generated UML documentation is out of date."
    echo "Run 'npm run uml', commit the updated files in doc-uml/, and update this pull request."
    git diff -- doc-uml
    exit 1

Co-authored-by: fuhrmanator <7606540+fuhrmanator@users.noreply.github.com>
Co-authored-by: fuhrmanator <7606540+fuhrmanator@users.noreply.github.com>
@fuhrmanator
fuhrmanator merged commit 67b54e5 into master Sep 20, 2026
5 checks passed
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