[issue-951] Clean up GitHub workflows and documentation - #952
Merged
Conversation
stiber
added
documentation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR focuses on repository maintenance: modernizing GitHub Actions CI, refreshing badges, and migrating developer documentation diagrams from generated PlantUML assets to inline Mermaid (plus adding tooling to auto-close stale/linked issues).
Changes:
- Split CI into separate Unit Test and Regression Test workflows; updated existing workflows and removed deprecated ones.
- Refreshed README/docs landing badges and updated developer documentation (including Mermaid-based diagrams).
- Added automation for issue hygiene (auto-close on merge workflow + a local cleanup script).
Reviewed changes
Copilot reviewed 34 out of 63 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| Testing/RunTests.sh | Updates header text to align with the new CI workflow structure. |
| README.md | Replaces/expands badges (DOI/docs/CI/license). |
| docs/index.md | Aligns docs landing page badges with README and CI workflow names. |
| docs/Developer/StudentSetup.md | Updates VS Code extension recommendation for Mermaid preview. |
| docs/Developer/SequenceDiagrams/topLevelFlow.puml | Removes legacy PlantUML diagram source (migrated to Mermaid). |
| docs/Developer/SequenceDiagrams/simulatorSimulate.puml | Removes legacy PlantUML diagram source (migrated to Mermaid). |
| docs/Developer/SequenceDiagrams/simulatorSetup.puml | Removes legacy PlantUML diagram source (migrated to Mermaid). |
| docs/Developer/SequenceDiagrams/simRecorderFlow.puml | Removes legacy PlantUML diagram source (migrated to Mermaid). |
| docs/Developer/SequenceDiagrams/simObjectsCreation.puml | Removes legacy PlantUML diagram source (migrated to Mermaid). |
| docs/Developer/SequenceDiagrams/diagrams/topLevelFlow.svg | Removes generated PlantUML artifact (SVG). |
| docs/Developer/SequenceDiagrams/diagrams/simulatorSimulate.svg | Removes generated PlantUML artifact (SVG). |
| docs/Developer/SequenceDiagrams/diagrams/simulatorSetup.svg | Removes generated PlantUML artifact (SVG). |
| docs/Developer/SequenceDiagrams/diagrams/simObjectsCreation.svg | Removes generated PlantUML artifact (SVG). |
| docs/Developer/sequenceDiagrams.md | Replaces image-based diagrams with inline Mermaid equivalents (adds recorder diagram too). |
| docs/Developer/index.md | Updates developer index links/descriptions to match new workflows and Mermaid docs. |
| docs/Developer/GHPages.md | Updates GitHub Pages publishing guidance and Mermaid preview guidance. |
| docs/Developer/GHActions.md | Refreshes workflow documentation and adds maintenance script section. |
| docs/Developer/ClassDiagrams/vertices.puml | Removes legacy PlantUML class diagram source. |
| docs/Developer/ClassDiagrams/updatedRecorder.puml | Removes legacy PlantUML class diagram source. |
| docs/Developer/ClassDiagrams/recorder.puml | Removes legacy PlantUML class diagram source. |
| docs/Developer/ClassDiagrams/recordable.puml | Removes legacy PlantUML class diagram source. |
| docs/Developer/ClassDiagrams/packages.puml | Removes legacy PlantUML class diagram source. |
| docs/Developer/ClassDiagrams/operationManager.puml | Removes legacy PlantUML class diagram source. |
| docs/Developer/ClassDiagrams/layout.puml | Removes legacy PlantUML class diagram source. |
| docs/Developer/ClassDiagrams/graphittiDomain.puml | Removes legacy PlantUML class diagram source. |
| docs/Developer/ClassDiagrams/graphitti.puml | Removes legacy PlantUML class diagram source. |
| docs/Developer/ClassDiagrams/edges.puml | Removes legacy PlantUML class diagram source. |
| docs/Developer/ClassDiagrams/core.puml | Removes legacy PlantUML class diagram source. |
| docs/Developer/ClassDiagrams/connections.puml | Removes legacy PlantUML class diagram source. |
| docs/Developer/ClassDiagrams/diagrams/OperationManagerClassDiagram.svg | Removes generated PlantUML artifact (SVG). |
| .github/workflows/unit-tests.yml | Adds a dedicated unit test workflow. |
| .github/workflows/regression-tests.yml | Renames/splits regression workflow away from unit tests; updates checkout action and build steps. |
| .github/workflows/publish-gh-pages.yml | Removes the manual publish workflow (replaced by workflow_dispatch on gh-pages.yml). |
| .github/workflows/plantUML.yml | Removes the PlantUML generation workflow (diagrams migrated away from PlantUML assets). |
| .github/workflows/gh-pages.yml | Adds manual dispatch, updates action versions, and sets permissions for publishing. |
| .github/workflows/format.yml | Expands branch filters and modernizes/install steps; renames job key. |
| .github/workflows/close-merged-issues.yml | Adds an action to close linked issues automatically when PRs merge. |
| .github/scripts/cleanup_stale_issues.sh | Adds a local maintenance script to find/close issues referenced by already-merged PRs. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Contributor
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 34 out of 63 changed files in this pull request and generated 1 comment.
Suppressed comments (3)
.github/workflows/regression-tests.yml:42
- This workflow sets
defaults.run.working-directory: buildbut does not create thebuild/directory (and the repo does not include it). The job will fail before configuration/build steps run because GitHub Actions can'tchdirintobuild/.
.github/scripts/cleanup_stale_issues.sh:104 - The comment says the script searches for "#123 in PR title", but the implementation only matches
[issue-123],issue-123/issue/123, and action-keyword references likefixes #123. This mismatch is confusing when updating the patterns later.
# Searches for patterns:
# 1. [issue-123] or [ISSUE-123]
# 2. issue-123 or issue/123 in branch name or text
# 3. (fixes|closes|resolves|closed|fixed|resolved) #123
# 4. #123 in PR title
Testing/RunTests.sh:6
- Capitalize the GitHub product name consistently: "GitHub Actions" (not "GitHub actions").
# It contains the same tests as the CI workflows that are executed by
# GitHub actions on Pull Requests:
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
closes #951
Lots of small fixes to clean up GitHub action workflow scripts, clean up old documentation, add pretty badges, and help clean out issues that should have gotten closed.
Checklist (Mandatory for new features)
[ ] Added Unit Tests(not relevant)Testing (Mandatory for all changes)
[ ] GPU Test:test-medium-connected.xmlPassed[ ] GPU Test:test-large-long.xmlPassedNeither of these are relevant; no Graphitti code changes