SCADE Suite Actions

Execute SCADE Suite command line tools on models.

Check model

The suite-check action executes scade.exe -check on a SCADE Suite project for a given configuration.

Source code for this action

Input	Description	Required	Default
scade-dir	Ansys SCADE installation directory.	True
project	Path of the SCADE Suite project.	True
configuration	Configuration to use for checking the model.	True
checkout	Whether to clone the repository on the CI/CD machine.	False	true

Output	Description
report	Path of the produced report.

Example

Check model basic example

suite-check:
  name: "Check model basic example"
  runs-on: [self-hosted, 'SCADE']
  steps:
    - name: "Check model"
      uses: ansys/scade-actions/suite-check@v2.1
      with:
        scade-dir: 'C:\Program Files\Ansys Inc\v242\SCADE'
        project: 'Model\CruiseControl.etp'
        configuration: 'KCG'

Check rules

The suite-rules action executes scade.exe -rules_checker on a SCADE Suite project for a given configuration.

Source code for this action

Input	Description	Required	Default
scade-dir	Ansys SCADE installation directory.	True
project	Path of the SCADE Suite project.	True
configuration	Configuration to use for checking the rules.	True
checkout	Whether to clone the repository on the CI/CD machine.	False	true

Output	Description
report	Path of the produced report.

Example

Check rules basic example

suite-rules:
  name: "Check rules basic example"
  runs-on: [self-hosted, 'SCADE']
  steps:
    - name: "Check rules"
      uses: ansys/scade-actions/suite-rules@v2.1
      with:
        scade-dir: 'C:\Program Files\Ansys Inc\v242\SCADE'
        project: 'Model\CruiseControl.etp'
        configuration: 'MetricRule'

Compute metrics

The suite-metrics action executes scade.exe -metrics on a SCADE Suite project for a given configuration.

Source code for this action

Input	Description	Required	Default
scade-dir	Ansys SCADE installation directory.	True
project	Path of the SCADE Suite project.	True
configuration	Configuration to use for checking the rules.	True
checkout	Whether to clone the repository on the CI/CD machine.	False	true

Output	Description
report	Path of the produced report.

Example

Compute metrics basic example

suite-metrics:
  name: "Compute metrics basic example"
  runs-on: [self-hosted, 'SCADE']
  steps:
    - name: "Compute metrics"
      uses: ansys/scade-actions/suite-metrics@v2.1
      with:
        scade-dir: 'C:\Program Files\Ansys Inc\v242\SCADE'
        project: 'Model\CruiseControl.etp'
        configuration: 'MetricRule'

Create report

The suite-report action executes scade.exe -report on a SCADE Suite project for a given configuration.

Source code for this action

Input	Description	Required	Default
scade-dir	Ansys SCADE installation directory.	True
project	Path of the SCADE Suite project.	True
configuration	Configuration to use for generating the documentation.	True
archive	Path of the zip archive to contain the report’s directory. When this option is used, it is advised to generate the documentation in a separate directory.	False
checkout	Whether to clone the repository on the CI/CD machine.	False	true

Output	Description
report	Path of the generated report.
target-directory	Path of the target directory where the report is generated.

Example

Create report

suite-report:
  name: "Create report"
  runs-on: [self-hosted, 'SCADE']
  steps:
    - name: "Create report"
      uses: ansys/scade-actions/suite-report@v2.1
      with:
        scade-dir: 'C:\Program Files\Ansys Inc\v242\SCADE'
        project: 'Model\CruiseControl.etp'
        configuration: 'RTF'

Generate code

The suite-code action executes scade.exe -code on a SCADE Suite project for a given configuration.

Source code for this action

Input	Description	Required	Default
scade-dir	Ansys SCADE installation directory.	True
project	Path of the SCADE Suite project.	True
configuration	Configuration to use for generating the code.	True
build	Whether scade.exe -code shall be called with the option -sim to build the generated code.	False	false
checkout	Whether to clone the repository on the CI/CD machine.	False	true

Output	Description
target-directory	Path of the target directory where the code is generated.

Example

Generate code basic example

suite-code:
  name: "Generate code basic example"
  runs-on: [self-hosted, 'SCADE']
  steps:
    - name: "Generate code"
      uses: ansys/scade-actions/suite-code@v2.1
      id: generate-code
      with:
        scade-dir: 'C:\Program Files\Ansys Inc\v242\SCADE'
        project: 'Model\CruiseControl.etp'
        configuration: 'KCG'

    - name: "Upload generated code to artifacts"
      uses: actions/upload-artifact@v4
      with:
        name: "generated-code"
        path: ${{ steps.generate-code.outputs.target-directory }}/*.*
        retention-days: 7
        if-no-files-found: error