Merge pull request #312 from Toufool/dev

February 2025 2.3.0 release

Author: Avasam

.github/ISSUE_TEMPLATE/bug-or-crash-report.md

@@ -7,38 +7,40 @@ assignees: ''
 
 ---
 
-**Describe the bug**
+### Describe the bug
 <!-- A clear and concise description of what the bug is. -->
 
-**To Reproduce**
+### To Reproduce
+
 Steps to reproduce the behavior:
 
 1. Go to '...'
 2. Click on '....'
 3. Scroll down to '....'
 4. See error
 
-**Expected behavior**
+### Expected behavior
 <!-- A clear and concise description of what you expected to happen. -->
 
-**Screenshots and recordings**
+### Screenshots and recordings
 <!-- If applicable, add screenshots and/or recordings to help explain your problem. -->
 
-**Traceback or Crash Report**
+### Traceback or Crash Report
+
 If AutoSplit showed an exception traceback, please paste it here:
 
-```
+```py
 
 ```
 <!-- If AutoSplit crashed and closed without saying anything, please check Windows' Event Viewer, under Windows Logs > Application, for any recent error relating to AutoSplit -->
 
-**Version (please complete the following information):**
+### Version (please complete the following information)
 
 - OS: [e.g. Windows 10.0.19045]
 - AutoSplit: [e.g. v2.0.0]
 
-**AutoSplit Profile and Split Images**
+### AutoSplit Profile and Split Images
 <!-- Please include your AutoSplit profile `.toml` file. You can also add your Split Images if relevant. -->
 
-**Additional context**
+### Additional context
 <!-- Add any other context about the problem here. -->

.github/ISSUE_TEMPLATE/feature_request.md

@@ -7,15 +7,15 @@ assignees: ''
 
 ---
 
-**Is your feature request related to a problem? Please describe.**
+### Is your feature request related to a problem? Please describe
 <!-- A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] -->
 
-**Describe the solution you'd like**
+### Describe the solution you'd like
 <!-- A clear and concise description of what you want to happen. -->
 
-**Describe alternatives you've considered**
+### Describe alternatives you've considered
 <!-- A clear and concise description of any alternative solutions or features you've considered. -->
 
-**Additional context**
+### Additional context
 <!-- Add any other context or screenshots about the feature request here. -->
 <!-- Please include an AutoSplit profile `.toml` file and/or Split Images if relevant. -->

.github/workflows/codeql-analysis.yml

@@ -13,10 +13,10 @@ name: "CodeQL"
 
 on:
   push:
-    branches: [main, master, develop, dev]
+    branches: [main, dev*]
   pull_request:
     # The branches below must be a subset of the branches above
-    branches: [develop, dev]
+    branches: [dev*]
   schedule:
     - cron: "26 13 * * 6"
 
@@ -35,11 +35,11 @@ jobs:
 
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
 
       # Initializes the CodeQL tools for scanning.
       - name: Initialize CodeQL
-        uses: github/codeql-action/init@v2
+        uses: github/codeql-action/init@v3
         with:
           languages: ${{ matrix.language }}
           # If you wish to specify custom queries, you can do so here or in a config file.
@@ -50,7 +50,7 @@ jobs:
       # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
       # If this step fails, then you should remove it and run the build manually (see below)
       - name: Autobuild
-        uses: github/codeql-action/autobuild@v2
+        uses: github/codeql-action/autobuild@v3
 
       # ℹ️ Command-line programs to run using the OS shell.
       # 📚 https://git.io/JvXDl
@@ -64,4 +64,4 @@ jobs:
       #   make release
 
       - name: Perform CodeQL Analysis
-        uses: github/codeql-action/analyze@v2
+        uses: github/codeql-action/analyze@v3

.github/workflows/lint-and-build.yml

@@ -11,7 +11,6 @@ on:
   push:
     branches:
       - main
-      - master
       - dev*
     paths:
       - "**.py"
@@ -21,7 +20,6 @@ on:
   pull_request:
     branches:
       - main
-      - master
       - dev*
     paths:
       - "**.py"
@@ -40,59 +38,69 @@ concurrency:
 
 jobs:
   ruff:
-    runs-on: windows-latest
-    strategy:
-      fail-fast: false
-      # Ruff is version and platform sensible
-      matrix:
-        python-version: ["3.10", "3.11", "3.12"]
+    runs-on: ubuntu-22.04
     steps:
       - name: Checkout ${{ github.repository }}/${{ github.ref }}
-        uses: actions/checkout@v3
-      - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v4
-        with:
-          python-version: ${{ matrix.python-version }}
-          cache: "pip"
-          cache-dependency-path: "scripts/requirements*.txt"
-      - run: scripts/install.ps1
+        uses: actions/checkout@v4
+      - name: Get Ruff version
+        id: ruff_version
+        run: |
+          $Env:RUFF_VERSION=Select-String -path scripts/requirements-dev.txt -pattern 'ruff ?([=<>~]?= ?[\d\.]+)' | %{ $_.Matches[0].Groups[1].Value }
+          echo $Env:RUFF_VERSION
+          echo "RUFF_VERSION=$Env:RUFF_VERSION" >> $Env:GITHUB_OUTPUT
         shell: pwsh
-      - run: ruff check .
+      - uses: astral-sh/ruff-action@v3
+        with:
+          version: ${{ steps.ruff_version.outputs.RUFF_VERSION }}
+      - run: ruff format --check
   Pyright:
-    runs-on: windows-latest
+    runs-on: ${{ matrix.os }}
     strategy:
       fail-fast: false
       # Pyright is version and platform sensible
       matrix:
-        python-version: ["3.10", "3.11", "3.12"]
+        os: [windows-latest, ubuntu-22.04]
+        python-version: ["3.11", "3.12", "3.13"]
     steps:
       - name: Checkout ${{ github.repository }}/${{ github.ref }}
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python-version }}
           cache: "pip"
           cache-dependency-path: "scripts/requirements*.txt"
       - run: scripts/install.ps1
         shell: pwsh
+      - name: Get pyright version
+        id: pyright_version
+        run: |
+          PYRIGHT_VERSION=$(grep '$pyrightVersion = ' 'scripts/lint.ps1' | cut -d "#" -f 1 | cut -d = -f 2 | tr -d " '")
+          echo pyright version: "${PYRIGHT_VERSION}"
+          echo PYRIGHT_VERSION="${PYRIGHT_VERSION}" >> "${GITHUB_OUTPUT}"
+        shell: bash
       - name: Analysing the code with Pyright
-        uses: jakebailey/pyright-action@v1
+        uses: jakebailey/pyright-action@v2
         with:
+          version: ${{ steps.pyright_version.outputs.PYRIGHT_VERSION }}
           working-directory: src/
           python-version: ${{ matrix.python-version }}
   Build:
-    runs-on: windows-latest
+    runs-on: ${{ matrix.os }}
     strategy:
       fail-fast: false
       # Only the Python version we plan on shipping matters.
       matrix:
-        python-version: ["3.11", "3.12"]
+        os: [windows-latest, ubuntu-22.04]
+        python-version: ["3.12", "3.13"]
+        include:
+          - os: ubuntu-22.04
+            python-version: "3.11" # I had some Qt Wayland issues on 3.12 for ubuntu-22.04 iirc. TODO: test it
     steps:
       - name: Checkout ${{ github.repository }}/${{ github.ref }}
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python-version }}
           cache: "pip"
@@ -102,15 +110,15 @@ jobs:
       - run: scripts/build.ps1
         shell: pwsh
       - name: Upload Build Artifact
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
-          name: AutoSplit (Python ${{ matrix.python-version }})
+          name: AutoSplit for ${{ matrix.os }} (Python ${{ matrix.python-version }})
           path: dist/AutoSplit*
           if-no-files-found: error
       - name: Upload Build logs
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
-          name: Build logs (Python ${{ matrix.python-version }})
+          name: Build logs for ${{ matrix.os }} (Python ${{ matrix.python-version }})
           path: |
             build/AutoSplit/*.toc
             build/AutoSplit/*.txt

.github/workflows/printenv.yml

@@ -10,7 +10,7 @@ on:
         type: boolean
   push:
     branches:
-      - master
+      - main
       - dev
 
 env:
@@ -22,5 +22,5 @@ jobs:
     runs-on: windows-latest
     steps:
       - name: Checkout ${{ github.repository }}/${{ github.ref }}
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - run: printenv

.pre-commit-config.yaml

@@ -1,6 +1,6 @@
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.5.0
+    rev: v5.0.0
     hooks:
       - id: pretty-format-json
         exclude: ".vscode/.*" # Exclude jsonc
@@ -9,31 +9,22 @@ repos:
         args: [--markdown-linebreak-ext=md]
       - id: end-of-file-fixer
       - id: mixed-line-ending
-        args: [--fix=crlf]
+        args: [--fix=lf]
       - id: check-case-conflict
   - repo: https://github.com/macisamuele/language-formatters-pre-commit-hooks
-    rev: v2.11.0
+    rev: v2.14.0
     hooks:
+      - id: pretty-format-yaml
+        args: [--autofix, --indent, "2", --offset, "2", --preserve-quotes, --line-width, "100"]
       - id: pretty-format-ini
         args: [--autofix]
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: "v0.1.7" # Must match requirements-dev.txt
+    rev: v0.8.5 # Must match requirements-dev.txt
     hooks:
       - id: ruff
         args: [--fix]
-  - repo: https://github.com/hhatto/autopep8
-    rev: "v2.0.4" # Must match requirements-dev.txt
-    hooks:
-      - id: autopep8
-  - repo: https://github.com/asottile/add-trailing-comma
-    rev: v3.1.0 # Must match requirements-dev.txt
-    hooks:
-      - id: add-trailing-comma
+      - id: ruff-format
 
 ci:
   autoupdate_branch: dev
-  autoupdate_schedule: monthly
-  skip:
-    # Ignore until Linux support. We don't want lf everywhere yet
-    # And crlf fails on CI because pre-commit runs on linux
-    - "mixed-line-ending"
+  autoupdate_schedule: quarterly

.sonarcloud.properties

@@ -1,11 +1,10 @@
 // Keep in alphabetical order
 {
   "recommendations": [
+    "charliermarsh.ruff",
     "davidanson.vscode-markdownlint",
     "eamodio.gitlens",
-    "emeraldwalk.runonsave",
     "github.vscode-github-actions",
-    "ms-python.autopep8",
     "ms-python.python",
     "ms-python.vscode-pylance",
     "ms-vscode.powershell",
@@ -32,11 +31,11 @@
     // Don't recommend to autoinstall //
     //
     // Use Ruff instead
+    "ms-python.autopep8",
+    "ms-python.black-formatter",
     "ms-python.flake8",
     "ms-python.isort",
     "ms-python.pylint",
-    // We use autopep8
-    "ms-python.black-formatter",
     // This is a Git project
     "johnstoncode.svn-scm",
     // Prefer using VSCode itself as a text editor

.vscode/extensions.json

@@ -6,7 +6,7 @@
   "configurations": [
     {
       "name": "Python: AutoSplit (debug non-user code)",
-      "type": "python",
+      "type": "debugpy",
       "request": "launch",
       "preLaunchTask": "Compile resources",
       "program": "src/AutoSplit.py",
@@ -15,7 +15,7 @@
     },
     {
       "name": "Python: AutoSplit",
-      "type": "python",
+      "type": "debugpy",
       "request": "launch",
       "preLaunchTask": "Compile resources",
       "program": "src/AutoSplit.py",
@@ -24,7 +24,7 @@
     },
     {
       "name": "Python: AutoSplit --auto-controlled",
-      "type": "python",
+      "type": "debugpy",
       "request": "launch",
       "preLaunchTask": "Compile resources",
       "program": "src/AutoSplit.py",