Skip to content

Commit

Permalink
up readme with correct model + autogenerate it
Browse files Browse the repository at this point in the history
  • Loading branch information
badetitou authored Apr 19, 2024
1 parent f0d3ea0 commit 10a839f
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 71 deletions.
71 changes: 1 addition & 70 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion ci/generatePUML.st
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
Expand Down

0 comments on commit 10a839f

Please sign in to comment.