You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: specifications/System/GitHubIntegration.md
+9-9Lines changed: 9 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -22,9 +22,9 @@ The system shall generate detailed change logs for pull requests, summarizing mo
22
22
* derivedFrom: [Integrate with GitHub Workflows](../UserStories.md#integrate-with-github-workflows)
23
23
---
24
24
25
-
### Automate Diagram Generation
25
+
### Automate Documentation Export
26
26
27
-
The system shall automate generation of diagrams in the GitHub workflow on PR merge event, so that the diagrams are always accessible and up-to-date.
27
+
The system shall automate export of HTML documentation in the GitHub workflow on PR merge event, so that the documentation is always accessible and up-to-date for GitHub Pages.
28
28
29
29
#### Metadata
30
30
* type: user-requirement
@@ -33,24 +33,24 @@ The system shall automate generation of diagrams in the GitHub workflow on PR me
33
33
* derivedFrom: [Integrate with GitHub Workflows](../UserStories.md#integrate-with-github-workflows)
34
34
---
35
35
36
-
### Automated Diagram Generation on PR Merge
36
+
### Automated Documentation Export on PR Merge
37
37
38
-
The system shall implement a GitHub workflow that automatically generates and commits updated diagrams when pull requests are merged to the main branch.
38
+
The system shall implement a GitHub workflow that automatically exports and commits updated HTML documentation when pull requests are merged to the main branch.
39
39
40
40
#### Details
41
41
The GitHub workflow shall:
42
42
- Be triggered only when a pull request is merged to the main branch (not on PR creation or updates)
43
43
- Check out the latest code from the main branch post-merge
44
44
- Build the Reqvire tool from source
45
-
- Run the diagram generation process using the `--generate-diagrams` flag
46
-
- Check if any diagrams have been added or modified
45
+
- Run the HTML export process using `reqvire export --output docs`
46
+
- Check if any documentation files have been added or modified
47
47
- Commit any updated files with a standardized commit message
48
48
- Push the updates back to the main branch
49
49
50
-
This ensures that the Mermaid diagrams in the repository are always up-to-date after changes are merged to the main branch, providing accurate visual representations of the latest model state without requiring manual intervention.
50
+
This ensures that the HTML documentation in the `docs/` folder is always up-to-date after changes are merged to the main branch, providing accurate documentation for GitHub Pages without requiring manual intervention.
0 commit comments