Merge pull request #3 from DSD-DBS/msg2cap

Importing ROS2 messages into Capella model

.commitlintrc.yml

@@ -0,0 +1,17 @@
+# SPDX-FileCopyrightText: Copyright DB InfraGO AG and contributors
+# SPDX-License-Identifier: CC0-1.0
+rules:
+  body-leading-blank: [2, always]
+  footer-leading-blank: [2, always]
+  scope-case: [2, always, lower-case]
+  subject-case: [2, always, sentence-case]
+  subject-empty: [2, never]
+  subject-full-stop: [2, never, .]
+  subject-max-length: [2, always, 72]
+  type-empty: [2, never]
+  type-enum:
+    [
+      2,
+      always,
+      [build, chore, ci, docs, feat, fix, merge, perf, refactor, revert, test],
+    ]

.git_archival.txt

@@ -1,4 +1,4 @@
-Copyright DB Netz AG and contributors
+Copyright DB InfraGO AG and contributors
 SPDX-License-Identifier: CC0-1.0
 
 node: $Format:%H$

.gitattributes

@@ -1,4 +1,4 @@
-# Copyright DB Netz AG and contributors
+# Copyright DB InfraGO AG and contributors
 # SPDX-License-Identifier: CC0-1.0
 
 * text=auto

.github/workflows/build-test-publish.yml

@@ -1,75 +1,74 @@
-# Copyright DB Netz AG and contributors
+# Copyright DB InfraGO AG and contributors
 # SPDX-License-Identifier: CC0-1.0
 
 name: Build
 
 on:
-  push:
-    branches: ["*"]
-    pull_request: [master]
-    tags: ["v*.*.*"]
+    push:
+        branches: ["*"]
+        pull_request: [master]
+        tags: ["v*.*.*"]
 
 jobs:
-  test:
-    name: Test with Python ${{matrix.python_version}} on ${{matrix.os}}
-    runs-on: ${{matrix.os}}
-    strategy:
-      fail-fast: false
-      matrix:
-        os: [ubuntu-latest]
-        python_version:
-          - "3.10"
-        include:
-          - os: windows-latest
-            python_version: "3.10"
-    steps:
-      - uses: actions/checkout@v2
-      - name: Set up Python ${{matrix.python_version}}
-        uses: actions/setup-python@v2
-        with:
-          python-version: ${{matrix.python_version}}
-      - uses: actions/cache@v2
-        with:
-          path: ~/.cache/pip
-          key: ${{runner.os}}-pip-${{hashFiles('pyproject.toml')}}
-          restore-keys: |
-            ${{runner.os}}-pip-
-            ${{runner.os}}-
-      - name: Upgrade Pip
-        run: |-
-          python -m pip install -U pip
-      - name: Install test dependencies
-        run: |-
-          python -m pip install '.[test]'
-      - name: Run unit tests
-        run: |-
-          python -m pytest --cov-report=term --cov=rosidl2capella --rootdir=.
+    test:
+        name: Test with Python ${{matrix.python_version}} on ${{matrix.os}}
+        runs-on: ${{matrix.os}}
+        strategy:
+            fail-fast: false
+            matrix:
+                os: [ubuntu-latest]
+                python_version:
+                    - "3.10"
+                    - "3.11"
+                    - "3.12"
+        steps:
+            - uses: actions/checkout@v2
+            - name: Set up Python ${{matrix.python_version}}
+              uses: actions/setup-python@v2
+              with:
+                  python-version: ${{matrix.python_version}}
+            - uses: actions/cache@v2
+              with:
+                  path: ~/.cache/pip
+                  key: ${{runner.os}}-pip-${{hashFiles('pyproject.toml')}}
+                  restore-keys: |
+                      ${{runner.os}}-pip-
+                      ${{runner.os}}-
+            - name: Upgrade Pip
+              run: |-
+                  python -m pip install -U pip
+            - name: Install test dependencies
+              run: |-
+                  python -m pip install '.[test]'
+            - name: Run unit tests
+              run: |-
+                  python -m pytest --cov-report=term --cov=capella_ros_tools --rootdir=.
 
-  publish:
-    name: Publish artifacts
-    runs-on: ubuntu-latest
-    needs: test
-    steps:
-      - uses: actions/checkout@v2
-      - name: Setup Python
-        uses: actions/setup-python@v2
-        with:
-          python-version: "3.10"
-      - name: Install dependencies
-        run: |-
-          python -m pip install -U pip
-          python -m pip install build twine
-      - name: Build packages
-        run: |-
-          python -m build
-      - name: Verify packages
-        run: |-
-          python -m twine check dist/*
-      - name: Upload artifacts
-        uses: actions/upload-artifact@v2
-        with:
-          name: Artifacts
-          path: 'dist/*'
-      - name: Publish to PyPI (release only)
-        if: startsWith(github.ref, 'refs/tags/v')
-        run: python -m twine upload -u __token__ -p ${{ secrets.PYPI_TOKEN }} --non-interactive dist/*
+    publish:
+        name: Publish artifacts
+        runs-on: ubuntu-latest
+        needs: test
+        steps:
+            - uses: actions/checkout@v2
+            - name: Setup Python
+              uses: actions/setup-python@v2
+              with:
+                  python-version: "3.10"
+            - name: Install dependencies
+              run: |-
+                  python -m pip install -U pip
+                  python -m pip install build twine
+            - name: Build packages
+              run: |-
+                  python -m build
+            - name: Verify packages
+              run: |-
+                  python -m twine check dist/*
+            - name: Upload artifacts
+              uses: actions/upload-artifact@v2
+              with:
+                  name: Artifacts
+                  path: "dist/*"
+            - name: Publish to PyPI (release only)
+              if: startsWith(github.ref, 'refs/tags/v')
+              run: python -m twine upload -u __token__ -p ${{ secrets.PYPI_TOKEN }} --non-interactive dist/*

.github/workflows/commit-check.yml

@@ -0,0 +1,57 @@
+# SPDX-FileCopyrightText: Copyright DB InfraGO AG and contributors
+# SPDX-License-Identifier: CC0-1.0
+
+name: Conventional Commits
+
+on:
+  pull_request:
+    branches: [master]
+
+jobs:
+  conventional-commits:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+      - name: Install commitlint
+        run: npm install -g @commitlint/cli
+      - name: Validate commit messages
+        id: conventional-commits
+        env:
+          SHA_FROM: ${{ github.event.pull_request.base.sha }}
+          SHA_TO: ${{ github.event.pull_request.head.sha }}
+        run: |
+          delim="_EOF_$(uuidgen)"
+          echo "validation-result<<$delim" >> "$GITHUB_OUTPUT"
+          r=0
+          commitlint --from "$SHA_FROM" --to "$SHA_TO" >> "$GITHUB_OUTPUT" 2>&1 || r=$?
+          echo "$delim" >> "$GITHUB_OUTPUT"
+          exit $r
+      - name: Post comment if validation failed
+        if: always() && steps.conventional-commits.outcome == 'failure'
+        uses: actions/github-script@v6
+        env:
+          TEXT: |-
+            The pull request does not conform to the conventional commit specification. Please ensure that your commit messages follow the spec: <https://www.conventionalcommits.org/>.
+            We also strongly recommend that you set up your development environment with pre-commit, as described in our [CONTRIBUTING guidelines](https://github.com/DSD-DBS/capella-ros-tools/blob/master/CONTRIBUTING.md). This will run all the important checks right before you commit your changes, and avoids lengthy CI wait time and round trips.
+
+            This is the commit validation log:
+            ```
+            ${{ steps.conventional-commits.outputs.validation-result }}
+            ```
+
+            Here are some examples of valid commit messages:
+            ```
+            build: Bump dependency versions
+            docs(user): Add model creation workflow
+            feat: Add a monitoring dashboard
+            ```
+        with:
+          script: |
+            github.rest.issues.createComment({
+              issue_number: context.issue.number,
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              body: process.env.TEXT
+            })

.github/workflows/docs.yml

@@ -1,39 +1,41 @@
-# Copyright DB Netz AG and contributors
+# Copyright DB InfraGO AG and contributors
 # SPDX-License-Identifier: CC0-1.0
 
 name: Docs
 
 on:
-  push:
-    branches: ["master"]
+    workflow_dispatch:
+    push:
+        branches: [master]
 
 jobs:
-  sphinx:
-    runs-on: ubuntu-latest
-    permissions:
-      contents: write
-    steps:
-      - uses: actions/checkout@v2
-        with:
-          fetch-depth: 0
-      - uses: actions/setup-python@v2
-        with:
-          python-version: "3.10"
-      - name: Upgrade pip
-        run: |
-          python -m pip install -U pip
-      - name: Install dependencies
-        run: |
-          python -m pip install '.[docs]'
-      - name: Auto-generate APIDOC sources
-        run: |-
-          sphinx-apidoc --output-dir docs/source/code --force .
-      - name: Create docs
-        run: |
-          make -C docs html
-      - name: Deploy
-        uses: peaceiris/actions-gh-pages@v3
-        with:
-          force_orphan: true
-          github_token: ${{ secrets.GITHUB_TOKEN }}
-          publish_dir: ./docs/build/html
+    sphinx:
+        runs-on: ubuntu-latest
+        permissions:
+            contents: write
+        steps:
+            - uses: actions/checkout@v3
+              with:
+                  fetch-depth: 0
+            - uses: actions/setup-python@v4
+              with:
+                  cache: pip
+                  cache-dependency-path: pyproject.toml
+                  python-version: "3.12"
+            - name: Upgrade pip
+              run: python -m pip install -U pip
+            - name: Install dependencies
+              run: |
+                  sudo apt-get install -y pandoc
+                  python -m pip install '.[docs]'
+            - name: Auto-generate APIDOC sources
+              run: make -C docs apidoc
+            - name: Create docs
+              run: make -C docs html
+            - name: Deploy
+              if: github.ref == 'refs/heads/master'
+              uses: peaceiris/actions-gh-pages@v3
+              with:
+                  force_orphan: true
+                  github_token: ${{ secrets.GITHUB_TOKEN }}
+                  publish_dir: ./docs/build/html

.github/workflows/lint.yml

@@ -1,4 +1,4 @@
-# Copyright DB Netz AG and contributors
+# Copyright DB InfraGO AG and contributors
 # SPDX-License-Identifier: CC0-1.0
 
 name: Lint
@@ -39,4 +39,4 @@ jobs:
           python -m pip install pylint
       - name: Run pylint
         run: |-
-          pylint -dfixme rosidl2capella || exit $(($? & ~24))
+          pylint -dfixme capella_ros_tools || exit $(($? & ~24))

.gitignore

@@ -1,4 +1,4 @@
-# Copyright DB Netz AG and contributors
+# Copyright DB InfraGO AG and contributors
 # SPDX-License-Identifier: CC0-1.0
 
 # Byte-compiled / optimized / DLL files