docs: Setup diagram auto gen #790
Merged
Conversation
This file contains 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
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #790 +/- ##
==========================================
+ Coverage 87.75% 87.84% +0.08%
==========================================
Files 104 90 -14
Lines 6631 5790 -841
==========================================
- Hits 5819 5086 -733
+ Misses 635 571 -64
+ Partials 177 133 -44 ☔ View full report in Codecov by Sentry. |
|
Everyone contributing to this PR have now signed the CLA. Thanks! |
CarlosNihelton
added a commit
that referenced
this pull request
Jun 18, 2024
CarlosNihelton
added a commit
that referenced
this pull request
Jun 18, 2024
This adds a workflow to automate generation of C4 diagrams. The source file is docs/workspace.dsl. The output dir is docs/diagrams/. A Docker container installs necessary dependencies including Graphviz. The action generates .png files of the images when a PR is submitted that changes the source file.
This is where the diagrams will be generated. A readme is included for explanatory purposes.
This is the source-of-truth for all the diagrams that will be generated. If a change is made to this file then the affected diagrams will be rerendered.
edibotopic
force-pushed
the
setup-diagram-auto-gen
branch
from
e61f038 to
65f1568
Compare
edibotopic
force-pushed
the
setup-diagram-auto-gen
branch
2 times, most recently
from
05fae71 to
65f1568
Compare
[Auto-generated pull request](https://github.com/canonical/ubuntu-pro-for-wsl/actions/workflows/autoupdate-structurizr-diagrams.yml) by GitHub Action
didrocks
approved these changes
Jun 19, 2024
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.
This proposed change sets up the repo for the automated generation of C4 diagrams in the docs.
In
/docs/there is aworkspace.dslfile that contains the source markup for all of the C4 diagrams.When a PR includes a change to the markup a GitHub action will be triggered that updates the affected diagrams.
The generated diagrams will be added to the
docs/diagrams/folder and can then be referenced in the rest of the documentation.If accepted, the change should make it easier to maintain/version the
workspace.dslsource and the diagrams along with the rest of the docs.It should also make it easier for any future contributors who wish to work on the diagrams specifically.
UDENG-2943