#193 Added guard on runs. Expanded readme

LieberLieber · Oct 2, 2023 · 6815178 · 6815178
1 parent 5c87120
commit 6815178
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 1 deletion.
diff --git a/.github/README.md b/.github/README.md
@@ -69,3 +69,10 @@ On a Desktop you can pull the published LemonTree Components to a LemonTreeCompo
 ## ConsistencyCheck
 On push the model consistency check is run, for now the results are just in the action output.
 
+## AutosarUmlActionExample
+This workflow runs only when the AUTOSAR model in `example-arxml` changes. Firstly, it runs the
+ [Incquery AUTOSAR-UML Bridge,](https://incquery.io/autosar-uml-bridge) using its provided
+ [action.](https://github.com/IncQueryLabs/incquery-suite-bridge-autosar-uml-action)
+ It then generates a document listing the changes, openable in LemonTree, using
+ LemonTree.Automation's `diff` functionality. Lastly, it pushes the updated EA model back to the
+ originating branch, automatically keeping the two manifestations of the model in synch.
diff --git a/.github/workflows/AutosarUmlActionExample.yml b/.github/workflows/AutosarUmlActionExample.yml
@@ -6,7 +6,9 @@
 # The following secrets need to be defined: INCQUERY_USERNAME, INCQUERY_PASSWORD, INCQUERY_AUTOSAR_UML_INTEGRATION_LICENSE
 
 on:
-  push
+  push:
+    paths:
+      - 'example-arxml'
 jobs:
   AutosarUml:
     defaults: