Skip to content

Commit

Permalink
refactored github action
Browse files Browse the repository at this point in the history
  • Loading branch information
Dragos0000 committed Nov 1, 2023
1 parent 1bc9b17 commit 0dd9a32
Show file tree
Hide file tree
Showing 32 changed files with 14 additions and 158,151 deletions.
56 changes: 13 additions & 43 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Main steps:
* Fork this repository
* Put your UML model/models export (XML file) in the implementation folder
* Configure model2owl using config folder
* Change GitHub action scripts available to include your ontologies
* Change GitHub action script available to include your ontologies

# Usage
## Naming conventions
Expand All @@ -31,10 +31,10 @@ implementation
* Copy model2owl-config folder into UML model implementation folder created at the previous step
* Configure model2owl using the files inside model2owl-config folder
## Adjust GitHub actions
In the folder .GitHub from this repository are 2 action scripts that will transform the UML model/models.
### Generate convention report and glossary
In the folder .GitHub from this repository there is one action script that will transform the UML model/models.
### Transform with model2owl

**File name:** generate_conventions_and_glossary.yml
**File name:** transform_with_model2owl.yml

Configure the trigger for this action changing the following lines
```yaml
Expand Down Expand Up @@ -63,37 +63,7 @@ implementation
To include both models for generating the convention report and glossary the variable should be
AVAILABLE_IMPLEMENTATIONS=(modelOne modelTwo)
```
### Transform UML model

**File name:** transform_ontology.yml

Configure the trigger for this action changing the following lines
```yaml
paths:
- "implementation/demo_ontology/xmi_conceptual_model/demo_ontology_CM.xml"
- "implementation/demo_ontology/xmi_conceptual_model/demo_ontology_module_CM.xml"
```
If any change is detected in the files that are included in the paths config will trigger this GitHub action.
The paths should be to the UML model export file.

Configure which of the implementation should be included by changing the AVAILABLE_IMPLEMENTATIONS variable
inside the action script.
```shell
AVAILABLE_IMPLEMENTATIONS=(demo_ontology demo_ontology_module)
```
Search in the script for this variable declaration as it has multiple usage and change the value accordingly.
The values in the list should be the folder names created for the UML model under the implementation folder.

```
Example:
implementation
|___modelOne
|___modelTwo
To include both models to transform into a formal OWL ontology and a SHACL shape the variable should be
AVAILABLE_IMPLEMENTATIONS=(modelOne modelTwo)
```
## Output
The output is automatically generated by the GitHub action scripts described previously. Each of the scripts will
do an automatic commit on the branch that was executed from. To see the output executing a git pull after the GitHub
Expand All @@ -112,9 +82,9 @@ be processed by GitHub action scripts
.github
glossary
|__static -> folder to hold css and js neccesary for the glossary
|__modelOne_CM-glossary.html
|__modelTwo_CM-glossary.html
|__ontologies-combined-glossary.html -> combined glossary
|__modelOne_CM_glossary.html
|__modelTwo_CM_glossary.html
|__ontologies_combined_glossary.html -> combined glossary
implementation
model2owl-config
```
Expand All @@ -127,13 +97,13 @@ below.
| |__static -> folder to hold css and js neccesary for the convention report
| |__modelOne_CM-convention-report.html
|__owl_ontology
| |__modelOne_CM-core.rdf
| |__modelOne_CM-core.ttl
| |__modelOne_CM-restrictions.rdf
| |__modelOne_CM-restrictions.ttl
| |__modelOne_CM_core.rdf
| |__modelOne_CM_core.ttl
| |__modelOne_CM_restrictions.rdf
| |__modelOne_CM_restrictions.ttl
|__shacl_shapes
| |__modelOne_CM-shacl.rdf
| |__modelOne_CM-shacl.rdf
| |__modelOne_CM_shapes.rdf
| |__modelOne_CM_shapes.rdf
|___model2owl-config
|___xmi_conceptual_model
|___modelTwo
Expand Down
6,469 changes: 0 additions & 6,469 deletions glossary/demo_ontology_CM-glossary.html

This file was deleted.

6,469 changes: 0 additions & 6,469 deletions glossary/demo_ontology_CM_glossary.html

This file was deleted.

Loading

0 comments on commit 0dd9a32

Please sign in to comment.