Release-0.0.1

.github/workflows/changelog.yml

@@ -0,0 +1,78 @@
+name: Check Changelog
+on:
+  pull_request:
+    branches:
+      - main
+      - dev
+  workflow_dispatch:
+
+jobs:
+  check-changelog:
+    runs-on: ubuntu-latest
+    if: github.ref_name != 'main'
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0  # Fetch all history for accurate comparison
+
+      - name: Check PR labels for changelog skip
+        id: check-skip
+        run: |
+          # Check if PR has the skip-changelog label
+          labels="${{ join(github.event.pull_request.labels.*.name, ' ') }}"
+          echo "PR labels: $labels"
+
+          if [[ "$labels" == *"skip-changelog"* ]]; then
+            echo "Found 'skip-changelog' label - skipping changelog check"
+            echo "skip=true" >> $GITHUB_OUTPUT
+          else
+            echo "No 'skip-changelog' label found - proceeding with changelog check"
+            echo "skip=false" >> $GITHUB_OUTPUT
+          fi
+
+      - name: Fetch target branch
+        if: steps.check-skip.outputs.skip != 'true'
+        run: |
+          git fetch origin ${{ github.event.pull_request.base.ref }}:refs/remotes/origin/${{ github.event.pull_request.base.ref }}
+
+      - name: Extract content above insertion marker from target branch
+        if: steps.check-skip.outputs.skip != 'true'
+        id: extract-target
+        run: |
+          marker="<!-- insertion marker -->"
+          # Extract content above the marker in the target branch
+          git show origin/${{ github.event.pull_request.base.ref }}:CHANGELOG.md | awk -v marker="$marker" '
+            BEGIN { found=0 }
+            $0 ~ marker { found=1; exit }
+            { if (!found) print }
+          ' | sed '/^\s*$/d' > target_above_marker.txt
+
+      - name: Extract content above insertion marker from PR branch
+        if: steps.check-skip.outputs.skip != 'true'
+        id: extract-pr
+        run: |
+          marker="<!-- insertion marker -->"
+          # Extract content above the marker in the PR branch
+          cat CHANGELOG.md | awk -v marker="$marker" '
+            BEGIN { found=0 }
+            $0 ~ marker { found=1; exit }
+            { if (!found) print }
+          ' | sed '/^\s*$/d' > pr_above_marker.txt
+
+      - name: Compare content above insertion marker
+        if: steps.check-skip.outputs.skip != 'true'
+        id: compare
+        run: |
+          if ! diff -q target_above_marker.txt pr_above_marker.txt > /dev/null; then
+            echo "Differences detected above the insertion marker in CHANGELOG.md."
+            exit 0
+          else
+            echo "No differences detected above the insertion marker."
+            exit 1
+          fi
+
+      - name: Skip changelog check
+        if: steps.check-skip.outputs.skip == 'true'
+        run: |
+          echo "Changelog check skipped due to PR label"

.github/workflows/check-pr-for-release-version.yml

@@ -0,0 +1,41 @@
+name: Release Pattern Check
+
+on:
+  pull_request:
+    branches:
+      - main
+    types: [opened, edited, reopened, synchronize]
+
+jobs:
+  check-release-pattern:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Check PR Title, Description, or Hotfix Branch
+        run: |
+          title="${{ github.event.pull_request.title }}"
+          body="${{ github.event.pull_request.body }}"
+          head_ref="${{ github.head_ref }}"
+
+          echo "PR title: $title"
+          echo "PR body: $body"
+          echo "PR source branch: $head_ref"
+
+          # Allow hotfix branches unconditionally
+          if [[ "$head_ref" == hotfix/* ]]; then
+            echo "✅ Hotfix branch detected ($head_ref). Skipping release pattern check."
+            exit 0
+          fi
+
+          # Regex: Release-x.y.z (case-insensitive)
+          regex='[Rr][Ee][Ll][Ee][Aa][Ss][Ee]-[0-9]+\.[0-9]+\.[0-9]+'
+
+          if [[ "$title" =~ $regex ]] || [[ "$body" =~ $regex ]]; then
+            echo "✅ Found valid Release pattern in title or description."
+            exit 0
+          else
+            echo "❌ Invalid PR."
+            echo "   Title or description must contain: Release-x.y.z (e.g., Release-1.2.3)"
+            echo "   OR the branch must start with: hotfix/"
+            exit 1
+          fi

.github/workflows/create-tag.yml

@@ -0,0 +1,128 @@
+name: Create Release Tag
+
+on:
+  pull_request:
+    types: [closed]
+    branches:
+      - main
+
+permissions:
+  contents: write
+  pull-requests: write
+
+jobs:
+  create-tag:
+    if: github.event.pull_request.merged == true
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          submodules: recursive
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: 3.13
+          cache: 'pip'
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -e .
+
+      - name: Extract release version (Release-x.y.z OR hotfix bump)
+        id: extract_version
+        shell: bash
+        run: |
+          set -euo pipefail
+
+          title="${{ github.event.pull_request.title }}"
+          body="${{ github.event.pull_request.body }}"
+          head_ref="${{ github.head_ref }}"   # PR source branch name, e.g. hotfix/...
+
+          echo "PR source branch: $head_ref"
+          echo "PR title: $title"
+
+          # Hotfix: version = latest tag + 1 in patch
+          if [[ "$head_ref" == hotfix/* ]]; then
+            echo "✅ Hotfix PR detected. Deducing version from latest tag + patch bump..."
+
+            git fetch --tags --force
+
+            version="$(increase_latest_tag --patch)"
+
+            echo "✅ Hotfix release version: $version"
+            echo "version=$version" >> "$GITHUB_OUTPUT"
+            exit 0
+          fi
+
+          # Non-hotfix: expect Release-x.y.z in title/body
+          regex='[Rr][Ee][Ll][Ee][Aa][Ss][Ee]-([0-9]+\.[0-9]+\.[0-9]+)'
+
+          if [[ "$title" =~ $regex ]]; then
+            version="${BASH_REMATCH[1]}"
+          elif [[ "$body" =~ $regex ]]; then
+            version="${BASH_REMATCH[1]}"
+          else
+            echo "❌ No valid release version found in PR title or description."
+            echo "   Expected: Release-x.y.z (e.g., Release-1.2.3)"
+            echo "   Or use a hotfix/* branch to auto-bump patch."
+            exit 1
+          fi
+
+          echo "✅ Found release version: $version"
+          echo "version=$version" >> "$GITHUB_OUTPUT"
+
+      - name: Update CHANGELOG.md
+        run: |
+          version="${{ steps.extract_version.outputs.version }}"
+          python3 update_changelog "$version"
+
+      - name: Commit and push changelog update
+        run: |
+          version="${{ steps.extract_version.outputs.version }}"
+          git config user.name "github-actions[bot]"
+          git config user.email "github-actions[bot]@users.noreply.github.com"
+
+          git add CHANGELOG.md
+          git commit -m "docs: update changelog for $version" || echo "No changes to commit"
+          git push origin HEAD:main
+
+      - name: Create Git tag
+        run: |
+          version="${{ steps.extract_version.outputs.version }}"
+          git config user.name "github-actions[bot]"
+          git config user.email "github-actions[bot]@users.noreply.github.com"
+
+          # Safety: don't fail if tag already exists (e.g., re-runs)
+          if git rev-parse -q --verify "refs/tags/$version" >/dev/null; then
+            echo "Tag $version already exists. Skipping tag creation."
+            exit 0
+          fi
+
+          git tag "$version"
+          git push origin "$version"
+
+      - name: Create GitHub Release
+        uses: softprops/action-gh-release@v2
+        with:
+          tag_name: ${{ steps.extract_version.outputs.version }}
+          name: Release ${{ steps.extract_version.outputs.version }}
+          body: |
+            🚀 **Automatic release:** `${{ steps.extract_version.outputs.version }}`
+            - Created from PR: #${{ github.event.pull_request.number }}
+            - Commit: `${{ github.sha }}`
+          draft: false
+          prerelease: false
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Merge main back into dev
+        run: |
+          git fetch origin dev
+          git checkout dev
+          git merge origin/main --no-edit
+          git push origin dev

.github/workflows/pytest.yml

@@ -0,0 +1,45 @@
+name: pytest
+
+on:
+  pull_request:
+    branches: ['*']
+  schedule:
+    - cron: '0 0 * * *'  # Daily at midnight
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: [3.12, 3.13]
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: ${{ matrix.python-version }}
+        cache: 'pip'
+
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install -e .[test]
+
+    - name: Run pytest
+      run: |
+        python -m pytest tests/ -v
+
+    - name: Upload coverage to Codecov
+      uses: codecov/codecov-action@v5
+      with:
+        token: ${{ secrets.CODECOV_TOKEN }}
+        slug: 97gamjak/devops
+        fail_ci_if_error: true
+        flags: unittests
+        verbose: true

.github/workflows/ruff.yml

@@ -0,0 +1,32 @@
+name: Ruff
+
+on:
+  pull_request:
+    branches: ['*']
+  schedule:
+    - cron: '0 0 * * *'  # Daily at midnight
+
+jobs:
+  ruff:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install ruff
+
+      - name: Run ruff check
+        run: ruff check .
+
+      - name: Run ruff format check
+        run: ruff format --check .

.gitignore

@@ -4,3 +4,8 @@ __pycache__
 .venv/
 dist/
 build/
+**.egg-info/
+tests/test.ipynb
+**_.*.py
+.coverage
+**/__version__.py

.vscode/settings.json

@@ -0,0 +1,8 @@
+{
+    "cSpell.words": [
+        "Codecov",
+        "levelname",
+        "MSTD",
+        "unittests"
+    ]
+}

CHANGELOG.md

@@ -0,0 +1,49 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+## Next Release
+
+### API
+
+- Add cli command `get_latest_tag`
+- Add cli command `increase_latest_tag`
+- Add new license checking rule to `cpp_checks`
+- Add cli command `generate_toml_template` to get a template default toml file
+- Add cli commands `add_license_header` and `add_license_headers`
+- Add cli command `filter_buggy_cpp_files`
+
+### Features
+
+#### Git
+
+- Add function to retrieve latest tag from git
+
+#### Config
+
+- Adding possibility to have a `devops.toml` or `.devops.toml` config file
+- Adding logging levels to toml file config: `global_level`, `utils_level`, `config_level`, `cpp_level`
+    ```toml
+    [logging]
+    global_level = "INFO"
+    cpp_level = "DEBUG"
+    ```
+- Adding `file.encoding` config for toml configuration
+
+#### CPP Rules
+
+- Add license check rule for cpp header and source files
+
+### Deployment
+
+#### CI/CD
+
+- Add checking if `CHANGELOG.md` was updated
+- Add ruff check and ruff format CI
+- Add pytest CI with python versions 3.12 and 3.13
+- Add automatic release CI for PRs to main (either via title or via hotfix/ branch)
+- Add overnight CI runs for pytest and ruff CIs
+- Add test coverage to pytest CI
+
+<!-- insertion marker -->
+