Merge pull request #101 from boschrexroth/feature/release3.4

update to release version 3.4
boschrexroth · Dec 2, 2024 · 475c23b · 475c23b
2 parents b49b847 + e862204
commit 475c23b
Show file tree

Hide file tree

Showing 1,052 changed files with 85,826 additions and 8,327 deletions.
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
@@ -2,37 +2,44 @@
 
 name: Mkdocs
 
-# Controls when the action will run. 
+# Controls when the action will run.
 on:
   # Triggers the workflow on push or pull request events but only for the develop branch
   push:
-    branches: [ main ]
-  pull_request:
-    branches: [ main ]
-
+    branches: [main]
+    tags:
+      - '*'
   # Allows you to run this workflow manually from the Actions tab
   workflow_dispatch:
 
 jobs:
   createdocu:
+    if: startsWith(github.ref, 'refs/tags/') #runs only tagged version
     runs-on: ubuntu-latest
     steps:
-      -
-        name: Checkout
-        uses: actions/checkout@v2
+      - name: Checkout
+        uses: actions/checkout@v4
         with:
           fetch-depth: 0
-      -
-        uses: actions/setup-python@v2
+
+      - name: Setup Python
+        uses: actions/setup-python@v5
         with:
           python-version: 3.x
-      -
-        run: pip install mkdocs-material
-      -
+
+      - name: Install Python packages
+        run: pip install mkdocs-material mike
+
+      - name: Update gh-pages
         run: |
           ls -alh
           find samples-*/ -name "*.md" | cpio -pd doc/
           find samples-*/ -name "*.png" | cpio -pd doc/
           find scripts/ -name "*.md" | cpio -pd doc/
           find scripts/ -name "*.png" | cpio -pd doc/
-          mkdocs gh-deploy --force
+
+          if [ -f "scripts/doc/update_doc.sh" ]; then
+            scripts/doc/update_doc.sh ${{ github.ref_name }}
+          fi
+          
+          mike deploy --push --update-aliases ${{ github.ref_name }} latest
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,116 +1,126 @@
-# Software Development Kit for ctrlX AUTOMATION
-
-## CHANGELOG
-
-### 3.2.0
-
-#### FIXED
-
-+ n/a
-
-#### CHANGED
-
-+ [Changes](https://github.com/boschrexroth/ctrlx-automation-sdk/compare/2.6.4...3.2.0)
-
-### 2.6.4
-
-#### FIXED
-
-+ Fix: Apps implementing a Datalayer provider using the Datalayer go API may crash randomly and unpredictable after a long period of running fine.
-
-#### CHANGED
-
-+ [Changes](https://github.com/boschrexroth/ctrlx-automation-sdk/compare/2.6.1...2.6.4)
-
-### 2.6.1
-
-#### FIXED
-
-+ n/a
-
-#### CHANGED
-
-+ [Changes](https://github.com/boschrexroth/ctrlx-automation-sdk/compare/2.4.0...2.6.1)
-
-### 2.4.0
-
-#### FIXED
-
-+ n/a
-
-#### CHANGED
-
-+ [Changes](https://github.com/boschrexroth/ctrlx-automation-sdk/compare/2.2.4...2.4.0)
-
-### 2.2.4 (SDK-V-0202.4)
-
-#### FIXED
-
-+ Fix: [Release SDK-V-0202.3](https://github.com/boschrexroth/ctrlx-automation-sdk/releases/tag/2.2.3) contained a not released .NET Datalayer API (3.3.1), instead of version 3.0.3.
-
-#### CHANGED
-
-+ [Changes](https://github.com/boschrexroth/ctrlx-automation-sdk/compare/2.2.0...2.2.3)
-
-### 2.2.3 (SDK-V-0202.3)
-
-#### FIXED
-
-+ Fix: [Direct call to the mddb compiler](https://github.com/boschrexroth/ctrlx-automation-sdk/pull/27)
-
-#### CHANGED
-
-+ [Changes](https://github.com/boschrexroth/ctrlx-automation-sdk/compare/2.2.0...2.2.3)
-
-### 2.2.0 (SDK-V-0202)
-
-#### CHANGED
-
-+ [Changes](https://github.com/boschrexroth/ctrlx-automation-sdk/compare/1.20.0...2.2.0)
-+ Changed: Update package-assets.md
-
-### 1.20.0 (SDK-V-0120)
-
-#### CHANGED
-
-+ [Changes](https://github.com/boschrexroth/ctrlx-automation-sdk/compare/1.18.0...1.20.0)
-
-### 1.18.0 (SDK-V-0118)
-
-#### CHANGED
-
-+ [Changes](https://github.com/boschrexroth/ctrlx-automation-sdk/compare/1.16.0...1.18.0)
-
-### 1.16.0 (SDK-V-0116)
-
-#### FIXED
-
-+ Fix: Removed broken links to source code and replaced by implementation description
-
-#### CHANGED
-
-+ [Changes](https://github.com/boschrexroth/ctrlx-automation-sdk/compare/1.14.0...1.16.0)
-+ Changed: Updated versions of package dependencies
-+ Changed: Use latest available dedicated package versions (removed caret)
-
-### 1.14.0 (SDK-V-0114)
-
-#### CHANGED
-
-+ [Changes](https://github.com/boschrexroth/ctrlx-automation-sdk/compare/1.12.1...1.14.0)
-
-### 1.12.1 (SDK-V-0112.1)
-
-#### CHANGED
-
-+ [Changes](https://github.com/boschrexroth/ctrlx-automation-sdk/compare/1.12.0...1.12.1)
-
-### 1.12.0 (SDK-V-0112)
-
-#### CHANGED
-
-+ [Changes](https://github.com/boschrexroth/ctrlx-automation-sdk/compare/1.10.0...1.12.0)
-
-### 1.10.0 (SDK-V-0110)
-
-Initial SDK release
+# Software Development Kit for ctrlX AUTOMATION
+
+## CHANGELOG
+
+### 3.4.0
+
+#### FIXED
+
++ n/a
+
+#### CHANGED
+
++ [Changes](https://github.com/boschrexroth/ctrlx-automation-sdk/compare/3.2.0..3.4.0)
+
+### 3.2.0
+
+#### FIXED
+
++ n/a
+
+#### CHANGED
+
++ [Changes](https://github.com/boschrexroth/ctrlx-automation-sdk/compare/2.6.4...3.2.0)
+
+### 2.6.4
+
+#### FIXED
+
++ Fix: Apps implementing a Datalayer provider using the Datalayer go API may crash randomly and unpredictable after a long period of running fine.
+
+#### CHANGED
+
++ [Changes](https://github.com/boschrexroth/ctrlx-automation-sdk/compare/2.6.1...2.6.4)
+
+### 2.6.1
+
+#### FIXED
+
++ n/a
+
+#### CHANGED
+
++ [Changes](https://github.com/boschrexroth/ctrlx-automation-sdk/compare/2.4.0...2.6.1)
+
+### 2.4.0
+
+#### FIXED
+
++ n/a
+
+#### CHANGED
+
++ [Changes](https://github.com/boschrexroth/ctrlx-automation-sdk/compare/2.2.4...2.4.0)
+
+### 2.2.4 (SDK-V-0202.4)
+
+#### FIXED
+
++ Fix: [Release SDK-V-0202.3](https://github.com/boschrexroth/ctrlx-automation-sdk/releases/tag/2.2.3) contained a not released .NET Datalayer API (3.3.1), instead of version 3.0.3.
+
+#### CHANGED
+
++ [Changes](https://github.com/boschrexroth/ctrlx-automation-sdk/compare/2.2.0...2.2.3)
+
+### 2.2.3 (SDK-V-0202.3)
+
+#### FIXED
+
++ Fix: [Direct call to the mddb compiler](https://github.com/boschrexroth/ctrlx-automation-sdk/pull/27)
+
+#### CHANGED
+
++ [Changes](https://github.com/boschrexroth/ctrlx-automation-sdk/compare/2.2.0...2.2.3)
+
+### 2.2.0 (SDK-V-0202)
+
+#### CHANGED
+
++ [Changes](https://github.com/boschrexroth/ctrlx-automation-sdk/compare/1.20.0...2.2.0)
++ Changed: Update package-assets.md
+
+### 1.20.0 (SDK-V-0120)
+
+#### CHANGED
+
++ [Changes](https://github.com/boschrexroth/ctrlx-automation-sdk/compare/1.18.0...1.20.0)
+
+### 1.18.0 (SDK-V-0118)
+
+#### CHANGED
+
++ [Changes](https://github.com/boschrexroth/ctrlx-automation-sdk/compare/1.16.0...1.18.0)
+
+### 1.16.0 (SDK-V-0116)
+
+#### FIXED
+
++ Fix: Removed broken links to source code and replaced by implementation description
+
+#### CHANGED
+
++ [Changes](https://github.com/boschrexroth/ctrlx-automation-sdk/compare/1.14.0...1.16.0)
++ Changed: Updated versions of package dependencies
++ Changed: Use latest available dedicated package versions (removed caret)
+
+### 1.14.0 (SDK-V-0114)
+
+#### CHANGED
+
++ [Changes](https://github.com/boschrexroth/ctrlx-automation-sdk/compare/1.12.1...1.14.0)
+
+### 1.12.1 (SDK-V-0112.1)
+
+#### CHANGED
+
++ [Changes](https://github.com/boschrexroth/ctrlx-automation-sdk/compare/1.12.0...1.12.1)
+
+### 1.12.0 (SDK-V-0112)
+
+#### CHANGED
+
++ [Changes](https://github.com/boschrexroth/ctrlx-automation-sdk/compare/1.10.0...1.12.0)
+
+### 1.10.0 (SDK-V-0110)
+
+Initial SDK release