feat: technical review

.github/dependabot.yml

@@ -0,0 +1,20 @@
+version: 2
+updates:
+  - package-ecosystem: "pip"
+    directory: "/requirements"
+    schedule:
+      interval: "daily"
+    commit-message:
+      prefix: "build"
+    labels:
+      - "maintenance"
+      - "dependencies"
+
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "daily"
+    commit-message:
+      prefix: "build"
+    labels:
+      - "maintenance"

.github/workflows/ci_cd.yml

@@ -72,7 +72,7 @@ jobs:
           issue-number: ${{ github.event.pull_request.number }}
           body: |
             Please add one of the following labels to add this contribution to the Release Notes :point_down:
-            - [bug](https://github.com/ansys/actions/pulls?q=label%3Abug+)
+            - [bug](https://github.com/ansys/scade-actions/pulls?q=label%3Abug+)
             - [documentation](https://github.com/ansys/scade-actions/pulls?q=label%3Adocumentation+)
             - [enhancement](https://github.com/ansys/scade-actions/pulls?q=label%3Aenhancement+)
             - [good first issue](https://github.com/ansys/scade-actions/pulls?q=label%3Agood+first+issue)
@@ -84,12 +84,13 @@ jobs:
     runs-on: ubuntu-latest
     needs: labeler
     steps:
-
-      - uses: ansys/actions/commit-style@main
+      - name: "Check commit style"
+        uses: ansys/actions/commit-style@v5
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
 
-      - uses: ansys/actions/branch-name-style@main
+      - name: "Check branch naming convention"
+        uses: ansys/actions/branch-name-style@v5
 
   code-style:
     name: "Code style"
@@ -137,20 +138,17 @@ jobs:
     runs-on: [self-hosted, 'SCADE']
     strategy:
       matrix:
-        # scade-version: ['23.1', '23.2']
         scade-version: ['23.2']
       fail-fast: false
     steps:
-      # - name: Checkout
-      #   uses: actions/checkout@v4
-      - name: Execute setup.py tests
+      - name: "Execute setup.py tests"
         uses: ./scade-tests-pytest
         with:
           scade-version: ${{ matrix.scade-version }}
           library-dir: "tests/python-setup"
           pytest-postargs: "tests/python-setup/tests -vv"
           checkout: false
-      - name: Execute pyproject tests
+      - name: "Execute pyproject tests"
         uses: ./scade-tests-pytest
         with:
           scade-version: ${{ matrix.scade-version }}
@@ -160,11 +158,65 @@ jobs:
 
   doc-deploy-dev:
     name: "Deploy developers documentation"
+    needs: [doc-build, tests]
     runs-on: ubuntu-latest
     if: github.event_name == 'push' && !contains(github.ref, 'refs/tags')
-    needs: [doc-build, tests]
     steps:
       - uses: ansys/actions/doc-deploy-dev@v5
         with:
             cname: ${{ env.DOCUMENTATION_CNAME }}
             token: ${{ secrets.GITHUB_TOKEN }}
+
+  release:
+    name: "Release to GitHub"
+    runs-on: ubuntu-latest
+    if: github.event_name == 'push' && contains(github.ref, 'refs/tags')
+    needs: [doc-build, tests]
+    steps:
+
+    - name: "Download HTML documentation"
+      uses: actions/download-artifact@v4
+      with:
+        name: documentation-html
+        path: documentation-html
+
+    - name: "Zip HTML documentation"
+      uses: vimtor/[email protected]
+      with:
+        files: documentation-html
+        dest: documentation-html.zip
+
+    - name: "Download PDF documentation"
+      uses: actions/download-artifact@v4
+      with:
+        name: documentation-pdf
+        path: documentation-pdf
+
+    - name: "Zip PDF documentation"
+      uses: vimtor/[email protected]
+      with:
+        files: documentation-pdf
+        dest: documentation-pdf.zip
+
+    - name: "Display the structure of downloaded files"
+      shell: bash
+      run: ls -R
+
+    - name: "Release to GitHub"
+      uses: softprops/action-gh-release@v1
+      with:
+        generate_release_notes: true
+        files: |
+          documentation-html.zip
+          documentation-pdf.zip
+
+  doc-deploy-stable:
+    name: "Upload stable documentation"
+    if: github.event_name == 'push' && contains(github.ref, 'refs/tags')
+    runs-on: ubuntu-latest
+    needs: release
+    steps:
+      - uses: ansys/actions/doc-deploy-stable@v5
+        with:
+          cname: ${{ env.DOCUMENTATION_CNAME }}
+          token: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/release.yml

@@ -0,0 +1,55 @@
+name: Rolling release
+on:
+  push:
+    tags:
+      - "v*.*.*"
+
+permissions: write-all
+
+jobs:
+  automate-tagging:
+    name: "Perform rolling release"
+    runs-on: ubuntu-latest
+    steps:
+    - name: "Checkout repository"
+      uses: actions/checkout@v4
+
+    - name: "Configure git"
+      run: |
+        git config user.name github-actions
+        git config user.email [email protected]
+
+    - name: "Decompose tag into components"
+      run: |
+        if [[ ${{ github.ref_name }} =~ ^v[0-9]+\.[0-9]+\.[0-9]+$ ]]; then
+          # Split the tag into its components
+          IFS='.' read -ra PARTS <<< "${{ github.ref_name }}"
+          echo "X=${PARTS[0]}" >> $GITHUB_ENV
+          echo "Y=${PARTS[1]}" >> $GITHUB_ENV
+          echo "Z=${PARTS[2]}" >> $GITHUB_ENV
+        else
+          echo "Invalid tag format. Expected vX.Y.Z but got ${{ github.ref_name }}"
+          exit 1
+        fi
+
+    - name: "Verify tag was created in the proper release branch"
+      run: |
+        # Remove leading "v" from env.X
+        X_NO_V="${X:1}"
+        # Check if the tag was created in the proper branch
+        if [[ ${{ github.event.base_ref }} != "refs/heads/release/${X_NO_V}.${{ env.Y }}" ]]; then
+          echo "Tag ${{ github.ref_name }} was created in the wrong branch. Expected branch name release/${X_NO_V}.${{ env.Y }}"
+          exit 1
+        fi
+
+    - name: "Remove old tags"
+      run: |
+        git push --delete origin ${{ env.X }}
+        git push --delete origin ${{ env.X }}.${{ env.Y }}
+
+    - name: "Create new tags"
+      run: |
+        git tag ${{ env.X }}.${{ env.Y }}
+        git tag ${{ env.X }}
+        git push origin ${{ env.X }}.${{ env.Y }}
+        git push origin ${{ env.X }}

.pre-commit-config.yaml

@@ -30,4 +30,4 @@ repos:
 - repo: https://github.com/python-jsonschema/check-jsonschema
   rev: 0.28.0
   hooks:
-    - id: check-github-workflows
+    - id: check-github-workflows

create-scade-venv/action.yml

@@ -28,24 +28,24 @@ runs:
   - name: Pass Inputs to Shell
     shell: cmd
     run: |
-            :: Pass inputs to the shell
-            echo INPUT_PYTHON_DIR=${{ inputs.python-dir }}>> %GITHUB_ENV%
-            echo INPUT_TARGET_DIR=${{ inputs.target-dir }}>> %GITHUB_ENV%
-            echo INPUT_TARGET_NAME=${{ inputs.target-name}}>> %GITHUB_ENV%
+      :: Pass inputs to the shell
+      echo INPUT_PYTHON_DIR=${{ inputs.python-dir }}>> %GITHUB_ENV%
+      echo INPUT_TARGET_DIR=${{ inputs.target-dir }}>> %GITHUB_ENV%
+      echo INPUT_TARGET_NAME=${{ inputs.target-name}}>> %GITHUB_ENV%
 
   - name: Create environment
     id: venv
     shell: cmd
     run: |
-            :: Create virtual environment
-            set VENV=%INPUT_TARGET_DIR%\%INPUT_TARGET_NAME%
-            if not exist "%VENV%" (
-                    echo Create virtual environment "%VENV%"
-                    "%INPUT_PYTHON_DIR%\python.exe" -m venv "%VENV%"
-            ) else (
-                    echo Skip existing virtual environment "%VENV%"
-            )
-            rem add the environment to the path
-            set PATH=%VENV%\Scripts;%PATH%
-            python --version
-            echo scripts-dir=%VENV%\Scripts>> %GITHUB_OUTPUT%
+      :: Create virtual environment
+      set VENV=%INPUT_TARGET_DIR%\%INPUT_TARGET_NAME%
+      if not exist "%VENV%" (
+              echo Create virtual environment "%VENV%"
+              "%INPUT_PYTHON_DIR%\python.exe" -m venv "%VENV%"
+      ) else (
+              echo Skip existing virtual environment "%VENV%"
+      )
+      rem add the environment to the path
+      set PATH=%VENV%\Scripts;%PATH%
+      python --version
+      echo scripts-dir=%VENV%\Scripts>> %GITHUB_OUTPUT%

doc/Makefile

@@ -3,7 +3,7 @@
 
 # You can set these variables from the command line. You can also
 # set the first two from the environment.
-SPHINXOPTS    ?=
+SPHINXOPTS    ?= -j auto -W
 SPHINXBUILD   ?= sphinx-build
 SOURCEDIR     = source
 BUILDDIR      = _build

get-scade-dir/action.yml

@@ -19,21 +19,21 @@ runs:
   - name: Pass Inputs to Shell
     shell: cmd
     run: |
-            :: Pass Inputs to Shell
-            echo INPUT_SCADE_VERSION=${{ inputs.scade-version }}>> %GITHUB_ENV%
+      :: Pass Inputs to Shell
+      echo INPUT_SCADE_VERSION=${{ inputs.scade-version }}>> %GITHUB_ENV%
 
   - name: Find SCADE_DIR
     id: find-scade-dir
     shell: cmd
     run: |
-            :: Find SCADE_DIR
-            echo Searching for Ansys SCADE "%INPUT_SCADE_VERSION%"
-            if "%INPUT_SCADE_VERSION%" lss "21.2" (set SCADE_COMPANY=Esterel Technologies) else (set SCADE_COMPANY=Ansys Inc)
-            echo SCADE registry company is "%SCADE_COMPANY%"
-            for /f "usebackq skip=2 tokens=2,*" %%A in (`REG QUERY "HKLM\SOFTWARE\%SCADE_COMPANY%\SCADE\%INPUT_SCADE_VERSION%" /v InstallDir 2^>nul`) do (set SCADE_DIR=%%B)
-            if "%SCADE_DIR%" == "" (
-                echo Ansys SCADE "%INPUT_SCADE_VERSION%" not available
-                exit /b 1
-            )
-            echo Ansys SCADE %INPUT_SCADE_VERSION% found in "%SCADE_DIR%"
-            echo scade-dir=%SCADE_DIR%>> %GITHUB_OUTPUT%
+      :: Find SCADE_DIR
+      echo Searching for Ansys SCADE "%INPUT_SCADE_VERSION%"
+      if "%INPUT_SCADE_VERSION%" lss "21.2" (set SCADE_COMPANY=Esterel Technologies) else (set SCADE_COMPANY=Ansys Inc)
+      echo SCADE registry company is "%SCADE_COMPANY%"
+      for /f "usebackq skip=2 tokens=2,*" %%A in (`REG QUERY "HKLM\SOFTWARE\%SCADE_COMPANY%\SCADE\%INPUT_SCADE_VERSION%" /v InstallDir 2^>nul`) do (set SCADE_DIR=%%B)
+      if "%SCADE_DIR%" == "" (
+          echo Ansys SCADE "%INPUT_SCADE_VERSION%" not available
+          exit /b 1
+      )
+      echo Ansys SCADE %INPUT_SCADE_VERSION% found in "%SCADE_DIR%"
+      echo scade-dir=%SCADE_DIR%>> %GITHUB_OUTPUT%

get-scade-python/action.yml

@@ -8,9 +8,8 @@ description: >
 inputs:
   scade-dir:
     description: >
-      Ansys SCADE Installation directory, e.g.::
-
-        C:\Program Files\Ansys Inc\v231\SCADE
+      Ansys SCADE Installation directory, for instance 
+      ``C:\Program Files\Ansys Inc\v231\SCADE``
     required: true
 
 outputs:
@@ -34,30 +33,30 @@ runs:
     id: set
     shell: cmd
     run: |
-            :: Pass Inputs to Shell
-            echo INPUT_SCADE_DIR=${{ inputs.scade-dir }}>> %GITHUB_ENV%
+      :: Pass Inputs to Shell
+      echo INPUT_SCADE_DIR=${{ inputs.scade-dir }}>> %GITHUB_ENV%
 
   - name: Retrieve Python name/directory/version
     id: get
     shell: cmd
     run: |
-            :: Retrieve Python name/directory
-            setlocal ENABLEDELAYEDEXPANSION
-            echo Get Python interpreter for "%INPUT_SCADE_DIR%"
-            set PYTHON_VERSION=0
-            for /f "usebackq" %%A in (`dir /B "%INPUT_SCADE_DIR%\contrib\Python*"`) do (
-                set CURRENT_VERSION=%%A
-                set CURRENT_VERSION=!CURRENT_VERSION:Python=%!
-                if !CURRENT_VERSION! GTR !PYTHON_VERSION! (
-                    set PYTHON_VERSION=!CURRENT_VERSION!
-                )
-            )
-            set PYTHON_NAME=Python%PYTHON_VERSION%
-            echo Python name="%PYTHON_NAME%"
-            echo python-name=%PYTHON_NAME%>> %GITHUB_OUTPUT%
-            set PYTHON_DIR=%INPUT_SCADE_DIR%\contrib\%PYTHON_NAME%
-            echo Python directory="%PYTHON_DIR%"
-            echo python-dir=%PYTHON_DIR%>> %GITHUB_OUTPUT%
-            for /f "usebackq tokens=2,3 delims=. " %%A in (`"%PYTHON_DIR%\python" --version`) do (set PYTHON_VERSION=%%A.%%B)
-            echo Python version="%PYTHON_VERSION%"
-            echo python-version=%PYTHON_VERSION%>> %GITHUB_OUTPUT%
+      :: Retrieve Python name/directory
+      setlocal ENABLEDELAYEDEXPANSION
+      echo Get Python interpreter for "%INPUT_SCADE_DIR%"
+      set PYTHON_VERSION=0
+      for /f "usebackq" %%A in (`dir /B "%INPUT_SCADE_DIR%\contrib\Python*"`) do (
+          set CURRENT_VERSION=%%A
+          set CURRENT_VERSION=!CURRENT_VERSION:Python=%!
+          if !CURRENT_VERSION! GTR !PYTHON_VERSION! (
+              set PYTHON_VERSION=!CURRENT_VERSION!
+          )
+      )
+      set PYTHON_NAME=Python%PYTHON_VERSION%
+      echo Python name="%PYTHON_NAME%"
+      echo python-name=%PYTHON_NAME%>> %GITHUB_OUTPUT%
+      set PYTHON_DIR=%INPUT_SCADE_DIR%\contrib\%PYTHON_NAME%
+      echo Python directory="%PYTHON_DIR%"
+      echo python-dir=%PYTHON_DIR%>> %GITHUB_OUTPUT%
+      for /f "usebackq tokens=2,3 delims=. " %%A in (`"%PYTHON_DIR%\python" --version`) do (set PYTHON_VERSION=%%A.%%B)
+      echo Python version="%PYTHON_VERSION%"
+      echo python-version=%PYTHON_VERSION%>> %GITHUB_OUTPUT%

scade-tests-pytest/action.yml

@@ -56,7 +56,7 @@ runs:
       uses: ./get-scade-dir
       id: get-scade-dir
       with:
-          scade-version: ${{ inputs.scade-version }}
+        scade-version: ${{ inputs.scade-version }}
 
     - name: "Retrieve SCADE Python interpreter"
       uses: ./get-scade-python