SCADE Display Actions#

Execute SCADE Display command line tools on models.

Check model#

The display-check action executes ScadeDisplayConsole.exe batch checkTXT or ScadeDisplayConsole.exe batch checkCSV on a SCADE Display project for a given specification.

Source code for this action

Input

Description

Required

Default

scade-dir

Ansys SCADE installation directory.

True

project

Path of the SCADE Display project.

True

specification

Set the name of the specification to check

True

output

Set the path to the generated report file

True

format

Format of the generated report ‘TXT’ or ‘CSV’

False

TXT

checkout

Whether to clone the repository on the CI/CD machine.

False

true

Example#

Check model basic example
display-check:
  name: "Check model basic example"
  runs-on: [self-hosted, 'SCADE']
  steps:
    - name: "Check model"
      uses: ansys/scade-actions/display-check@v2.1
      with:
        scade-dir: 'C:\Program Files\Ansys Inc\v242\SCADE'
        project: 'Model\Model.etp'
        specification: 'specification.sgfx'
        format: 'CSV'
        output: 'design-checker-report-specification.csv'

Generate configuration#

The display-generate action executes ScadeDisplayConsole.exe batch generate on a SCADE Display project for a given configuration.

Using a configuration type ‘Code’, the code will be generated.

Using a configuration type ‘Windows’, a standalone executable will be produced.

Source code for this action

Input

Description

Required

Default

scade-dir

Ansys SCADE installation directory.

True

project

Path of the SCADE Display project.

True

configuration

Configuration to use for generation.

True

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
display-generate:
  name: "Generate code basic example"
  runs-on: [self-hosted, 'SCADE']
  steps:
    - name: "Generate configuration"
      uses: ansys/scade-actions/display-generate@v2.1
      id: generate-code
      with:
        scade-dir: 'C:\Program Files\Ansys Inc\v242\SCADE'
        project: 'Model\Model.etp'
        configuration: 'Code'

    - 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

Create report#

The display-report action executes SCADEDisplayConsole.exe batch report on a SCADE Display 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 Display project.

True

configuration

Configuration to use for generating the documentation.

True

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
display-report:
  name: "Create report"
  runs-on: [self-hosted, 'SCADE']
  steps:
    - name: "Create report"
      uses: ansys/scade-actions/display-report@v2.1
      with:
        scade-dir: 'C:\Program Files\Ansys Inc\v242\SCADE'
        project: 'Model\Model.etp'
        configuration: 'RTF'