Add CI/CD pipeline for automated releases

Author: kelltom

.github/workflows/release.yml

@@ -0,0 +1,99 @@
+name: Build and Release
+
+on:
+  push:
+    branches:
+      - main
+    tags:
+      - 'v*'
+
+jobs:
+  build-and-release:
+    runs-on: windows-latest
+    
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v4
+    
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: '3.11'
+    
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install -e ".[dev]"
+    
+    - name: Build with PyInstaller
+      run: |
+        pyinstaller --onefile --windowed --name "PDF-Page-Selector" --add-data "style.qss;." main.py
+    
+    - name: Set up .NET
+      uses: actions/setup-dotnet@v4
+      with:
+        dotnet-version: '8.0.x'
+    
+    - name: Install vpk
+      run: dotnet tool install -g vpk
+    
+    - name: Generate version number
+      id: version
+      run: |
+        $version = "1.0.${{ github.run_number }}"
+        echo "VERSION=$version" >> $env:GITHUB_OUTPUT
+        echo "Version: $version"
+    
+    - name: Package with Velopack
+      run: |
+        vpk pack --packId kelltom.pdfpageselector --packVersion ${{ steps.version.outputs.VERSION }} --packDir .\dist --mainExe PDF-Page-Selector.exe
+    
+    - name: Create Release
+      id: create_release
+      uses: actions/create-release@v1
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      with:
+        tag_name: v${{ steps.version.outputs.VERSION }}
+        release_name: Release v${{ steps.version.outputs.VERSION }}
+        draft: false
+        prerelease: false
+    
+    - name: Upload Release Assets
+      uses: actions/upload-release-asset@v1
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      with:
+        upload_url: ${{ steps.create_release.outputs.upload_url }}
+        asset_path: ./Releases/kelltom.pdfpageselector-${{ steps.version.outputs.VERSION }}-win-Setup.exe
+        asset_name: PDF-Page-Selector-Setup.exe
+        asset_content_type: application/octet-stream
+    
+    - name: Upload RELEASES file
+      uses: actions/upload-release-asset@v1
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      with:
+        upload_url: ${{ steps.create_release.outputs.upload_url }}
+        asset_path: ./Releases/RELEASES
+        asset_name: RELEASES
+        asset_content_type: text/plain
+    
+    - name: Upload nupkg file
+      run: |
+        $nupkg = Get-ChildItem -Path .\Releases\*.nupkg | Select-Object -First 1
+        if ($nupkg) {
+          echo "NUPKG_PATH=$($nupkg.FullName)" >> $env:GITHUB_OUTPUT
+          echo "NUPKG_NAME=$($nupkg.Name)" >> $env:GITHUB_OUTPUT
+        }
+      id: find_nupkg
+    
+    - name: Upload nupkg to release
+      uses: actions/upload-release-asset@v1
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      with:
+        upload_url: ${{ steps.create_release.outputs.upload_url }}
+        asset_path: ${{ steps.find_nupkg.outputs.NUPKG_PATH }}
+        asset_name: ${{ steps.find_nupkg.outputs.NUPKG_NAME }}
+        asset_content_type: application/octet-stream

.gitignore

@@ -26,6 +26,9 @@ share/python-wheels/
 *.egg
 MANIFEST
 
+# Velopack releases
+Releases/
+
 # PyInstaller
 #   Usually these files are written by a python script from a template
 #   before PyInstaller builds the exe, so as to inject date/other infos into it.

main.py

@@ -1,14 +1,15 @@
 import os
 import sys
-from pathlib import Path
+import fitz  # PyMuPDF
+import velopack
 
+from pathlib import Path
 from PyQt6.QtWidgets import (QApplication, QMainWindow, QWidget, QVBoxLayout, 
                              QHBoxLayout, QLabel, QPushButton, QLineEdit, 
                              QFileDialog, QMessageBox, QGroupBox, QRadioButton, 
-                             QButtonGroup)
+                             QButtonGroup, QMenu)
 from PyQt6.QtCore import Qt
-from PyQt6.QtGui import QFont
-import fitz  # PyMuPDF
+from PyQt6.QtGui import QFont, QAction
 
 
 class Mode:
@@ -248,6 +249,37 @@ def convert_to_images(input_path, page_numbers, output_path):
     return message
 
 
+def update_app():
+    """Check for updates and apply them if available."""
+    try:
+        # Check for updates from GitHub releases
+        # GitHub Actions will upload release files to the latest release
+        manager = velopack.UpdateManager("https://github.com/kelltom/pdf-page-selector/releases/latest/download/")
+        update_info = manager.check_for_updates()
+        
+        if not update_info:
+            QMessageBox.information(None, "No Updates", "You're running the latest version!")
+            return  # no updates available
+        
+        # Ask user if they want to update
+        reply = QMessageBox.question(
+            None, "Update Available",
+            f"A new version is available. Would you like to download and install it?\n\nThis will restart the application.",
+            QMessageBox.StandardButton.Yes | QMessageBox.StandardButton.No
+        )
+        
+        if reply == QMessageBox.StandardButton.Yes:
+            # Download the updates
+            manager.download_updates(update_info)
+            
+            # Apply the update and restart the app
+            manager.apply_updates_and_restart(update_info)
+    except Exception as e:
+        # Only show error if it's not the "NotInstalled" development mode error
+        if "NotInstalled" not in str(e):
+            QMessageBox.warning(None, "Update Error", f"Could not check for updates:\n{str(e)}")
+
+
 class PDFPageSelectorApp(QMainWindow):
     def __init__(self):
         super().__init__()
@@ -302,6 +334,9 @@ def init_ui(self):
         self.resize(400, 580)
         self.setStyleSheet(load_stylesheet())
 
+        # Create menu bar
+        self._create_menu_bar()
+        
         central_widget = QWidget()
         self.setCentralWidget(central_widget)
         layout = QVBoxLayout(central_widget)
@@ -344,6 +379,18 @@ def init_ui(self):
 
         layout.addStretch()
 
+    def _create_menu_bar(self):
+        """Create the application menu bar."""
+        menubar = self.menuBar()
+        
+        # Help menu
+        help_menu = menubar.addMenu("Help")
+        
+        # Check for Updates action
+        update_action = QAction("Check for Updates", self)
+        update_action.triggered.connect(update_app)
+        help_menu.addAction(update_action)
+    
     def _create_input_section(self):
         group = QGroupBox("Input PDF")
         layout = QVBoxLayout()
@@ -564,6 +611,9 @@ def _ensure_output_path(self):
 
 
 if __name__ == "__main__":
+    # Velopack needs to run first - it may quit/restart the process
+    velopack.App().run()
+    
     app = QApplication(sys.argv)
     window = PDFPageSelectorApp()
     window.show()

pyproject.toml

@@ -33,6 +33,7 @@ dependencies = [
 [project.optional-dependencies]
 dev = [
     "pyinstaller>=6.16.0",
+    "velopack>=0.0.1369",
 ]
 
 [project.urls]