merge: Update project infrastructure

.commitlintrc.yml

@@ -0,0 +1,19 @@
+# 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],
+    ]
+extends:
+  - '@commitlint/config-conventional'

.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$

.git_commit_template

@@ -0,0 +1,23 @@
+
+
+# type(scope)[!]: <subject> (max 50 chars, do not end with period)
+# Conventional Commits: https://www.conventionalcommits.org/en/v1.0.0/#summary
+# Seven rules of commits: https://chris.beams.io/posts/git-commit/#seven-rules
+#
+# commit types:
+# - build    (anything related to the package build)
+# - chore    (cosmetic commits without behavioral changes to production code)
+# - ci       (anything related to the CI setup)
+# - docs     (anything related to the documentation)
+# - feat     (new feature)
+# - fix      (bug fix)
+# - merge    (merge commit)
+# - perf     (performance improvements)
+# - refactor (improvements without externally visible behavior changes)
+# - revert   (other commit(s) was/were reverted)
+# - test     (only changes to the test setup)
+
+# commit scopes:
+# - core code: (...)
+# - extensions: (...)
+# - (docs)

.git_commit_template.license

@@ -0,0 +1,2 @@
+# Copyright DB InfraGO AG and contributors
+# SPDX-License-Identifier: Apache-2.0

.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

@@ -0,0 +1,71 @@
+# Copyright DB InfraGO AG and contributors
+# SPDX-License-Identifier: CC0-1.0
+
+name: Build
+
+on:
+  pull_request:
+  push:
+    branches: [master]
+    tags: ["v*"]
+  workflow_dispatch:
+
+jobs:
+  pre-commit:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          cache: pip
+          cache-dependency-path: pyproject.toml
+          python-version: "3.11"
+      - name: Upgrade pip
+        run: python -m pip install -U pip
+      - name: Install pre-commit
+        run: python -m pip install pre-commit types-docutils
+      - name: Run Pre-Commit
+        run: pre-commit run --all-files
+
+  build:
+    name: Build wheel
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+      - 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@v4
+        with:
+          name: Artifacts
+          path: 'dist/*'
+  pypi:
+    name: Publish to PyPI
+    runs-on: ubuntu-latest
+    needs: [build]
+    if: startsWith(github.ref, 'refs/tags/v')
+    environment:
+      name: pypi
+      url: https://pypi.org/project/capella-diff-tools
+    permissions:
+      id-token: write
+    steps:
+      - name: Download built wheel
+        uses: actions/download-artifact@v4
+        with:
+          name: python-package-distributions
+          path: dist/
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

.github/workflows/commit-check.yml

@@ -0,0 +1,63 @@
+# 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
+    concurrency:
+      group: commit-check-pr-${{ github.event.pull_request.number }}
+      cancel-in-progress: true
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: Install commitlint
+        run: npm install @commitlint/cli @commitlint/config-conventional
+      - 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
+          npx commitlint --from "$SHA_FROM" --to "$SHA_TO" >> "$GITHUB_OUTPUT" 2>&1 || r=$?
+          echo "$delim" >> "$GITHUB_OUTPUT"
+          exit $r
+      - name: Find conventional commit comment on PR
+        uses: peter-evans/find-comment@v3
+        if: always() && steps.conventional-commits.outcome == 'failure'
+        id: fc
+        with:
+          issue-number: ${{ github.event.pull_request.number }}
+          comment-author: 'github-actions[bot]'
+          body-includes: conventional commit
+      - name: Post comment if validation failed
+        uses: peter-evans/create-or-update-comment@v4
+        if: always() && steps.conventional-commits.outcome == 'failure'
+        with:
+          comment-id: ${{ steps.fc.outputs.comment-id }}
+          issue-number: ${{ github.event.pull_request.number }}
+          body: |
+            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-diff-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
+            ```
+          edit-mode: replace

.github/workflows/docs.yml

@@ -1,22 +1,24 @@
-# Copyright DB Netz AG and contributors
+# Copyright DB InfraGO AG and contributors
 # SPDX-License-Identifier: CC0-1.0
 
 name: Docs
 
 on:
+  pull_request:
   push:
-    branches: ["master"]
+    branches: [master]
+  workflow_dispatch:
 
 jobs:
   sphinx:
     runs-on: ubuntu-latest
     permissions:
       contents: write
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
         with:
           fetch-depth: 0
-      - uses: actions/setup-python@v2
+      - uses: actions/setup-python@v5
         with:
           python-version: "3.11"
       - name: Upgrade pip
@@ -31,7 +33,15 @@ jobs:
       - name: Create docs
         run: |
           make -C docs html
+      - name: Upload built docs as artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: Documentation
+          path: docs/build/html
+          if-no-files-found: error
+          retention-days: 5
       - name: Deploy
+        if: github.ref == 'refs/heads/master'
         uses: peaceiris/actions-gh-pages@v3
         with:
           force_orphan: true

.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