diff --git a/images/connections.svg b/images/connections.svg new file mode 100644 index 0000000..1133461 --- /dev/null +++ b/images/connections.svg @@ -0,0 +1,578 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/readme.md b/readme.md new file mode 100644 index 0000000..d38983d --- /dev/null +++ b/readme.md @@ -0,0 +1,83 @@ +# Github Action to deploy and run the IncQuery AUTOSAR-UML Bridge + +[![IncQuery AUTOSAR-UML Bridge Example](https://github.com/IncQueryLabs/incquery-suite-bridge-autosar-uml-action/actions/workflows/AutosarUmlActionExample.yml/badge.svg)](https://github.com/IncQueryLabs/incquery-suite-bridge-autosar-uml-action/actions/workflows/AutosarUmlActionExample.yml) + +This repository contains a GitHub Action for deploying and running the IncQuery AUTOSAR-UML Bridge. + The repository also contains a workflow example demonstrating how to use the action. + +## What does this action do? + +Firslty, this action downloads and installs **IncQuery AUTOSAR-UML Bridge** + (unless already installed on the GitHub Runner), then executes a transformation on an input AUTSOAR model, + adding corresponding elements to the specified Enterprise Architect model. + Then, should this result in a change in the Enterprise Architect model, the result is pushed back onto the + triggering branch. + +## About the IncQuery AUTOSAR-UML Bridge + +

+ +

+ +This works for both documentation purposes, as well as handover automation between architecture and detailed design. + The IncQuery AUTOSAR-UML Bridge creates UML elements for the complete AUTOSAR hierarchy, so that software component + and sequence diagrams can be created easily. + Its seamless integration with Sparx Systems Enterprise Architect helps to streamline the overall design process. + +For more information visit [https://incquery.io/autosar-uml-bridge](https://incquery.io/autosar-uml-bridge). + +## Usage + +### Requirements + +In case of GitHub hosted runner: +- windows-2022 (or newer) runner +- Valid license +- Credentials to access the **IncQuery AUTOSAR-UML Bridge** release + +In case of self hosted runner: +- Runner hosted on Windows 10 x64 1803 April 2018 Update or newer +- Valid license +- Credentials to access the **IncQuery AUTOSAR-UML Bridge** or the Bridge being pre-installed on the runner + +The following secrets need to be configured in the repository: +- If the IncQuery AUTOSAR-UML Bridge is not pre-installed on the runner: + INCQUERY_USERNAME, INCQUERY_PASSWORD to access the Bridge releases +- INCQUERY_AUTOSAR_UML_INTEGRATION_LICENSE: contents of the license file as-is + +### Example step + +```yaml +- name: Run IncQuery AUTOSAR-UML Bridge + uses: IncQueryLabs/incquery-suite-bridge-autosar-uml-action@v1 + with: + arxml_folder_path: example-arxml + ea_model_file_path: counting-logic.qeax + incquery_username: "${{ secrets.INCQUERY_USERNAME }}" + incquery_password: "${{ secrets.INCQUERY_PASSWORD }}" + license: "${{ secrets.INCQUERY_AUTOSAR_UML_INTEGRATION_LICENSE }}" +``` + +See [AutosarUmlActionExample.yml](.github/workflows/AutosarUmlActionExample.yml) for an example of a full workflow. + +### Parameters + +#### arxml_folder_path + +Path to the AUTOSAR model. Can point to a singe ARXML file, or a folder containing multiple ARXML files. + This parameter is mandatory. + +#### ea_model_file_path + +Path to the Enterprise Architect model file, probably .eapx or .qeax. + This parameter is mandatory. + +#### incquery_username, incquery_password + +Username and password to *artifacts.incquery.io*. + If the runner does not have the Validator already installed, then these parameters are required. + +#### license + +Contents of the license file as-is. The AutosarUMLIntegration and AutosarUMLIntegrationCI license features are required. + This parameter is mandatory.