From 10a839f2fccc31f4655818b8416791dea1054b3f Mon Sep 17 00:00:00 2001 From: Benoit Verhaeghe Date: Fri, 19 Apr 2024 15:25:37 +0200 Subject: [PATCH] up readme with correct model + autogenerate it --- README.md | 71 +--------------------------------------------- ci/generatePUML.st | 2 +- 2 files changed, 2 insertions(+), 71 deletions(-) diff --git a/README.md b/README.md index 1410fa5..2705200 100644 --- a/README.md +++ b/README.md @@ -97,76 +97,7 @@ canvas svgExporter Here is the metamodel used in this project -```mermaid -classDiagram - class Group { - avatar_url - name - id - web_url - description - visibility - } - class Repository - class Branch { - name - } - class FileDirectory { - name - } - class Pipeline { - status - } - class FileBlob { - name - } - class File { - name - } - class Project { - creator_id - avatar_url - name - id - readme_url - web_url - archived - description - } - class User { - created_at - pronouns - twitter - linkedin - avatar_url - name - id - work_information - bot - job_title - public_email - following - web_url - bio - website_url - skype - username - state - followers - organization - location - } - File <|-- FileDirectory - File <|-- FileBlob - Group *-- Group : group - Repository *-- Branch : repository - Project *-- Pipeline : project - Branch *-- File : branch - FileDirectory *-- File : directoryOwner - Repository -- Project : repository - Group *-- Project : group - User -- Project : creator -``` +![GitProject meta-model png](https://raw.githubusercontent.com/moosetechnology/GitProjectHealth/v1/doc/gitproject.png) ## Contributor diff --git a/ci/generatePUML.st b/ci/generatePUML.st index 3628d94..f957676 100644 --- a/ci/generatePUML.st +++ b/ci/generatePUML.st @@ -2,7 +2,7 @@ documentor := FamixUMLDocumentor new. documentor model: GLHModel; beWithStubs; - excludeClasses: { GLHModel. TEntityMetaLevelDependency. Object }; + excludeClasses: { GLHModel. TEntityMetaLevelDependency. Object . GLHEntity . GLHTEntityCreator }; generate. 'gitproject.puml' asFileReference writeStreamDo: [ :stream |